Skip to content
This repository has been archived by the owner on Apr 21, 2021. It is now read-only.

Commit

Permalink
docs: few fixes and tweaks (#54)
Browse files Browse the repository at this point in the history
* aloha, remove use of h1

* docs: move over docs, style footer
  • Loading branch information
jakebolam authored Feb 4, 2019
1 parent c316ef4 commit ff89015
Show file tree
Hide file tree
Showing 12 changed files with 163 additions and 55 deletions.
75 changes: 75 additions & 0 deletions docs/project/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
id: code-of-conduct
title: Contributor Covenant Code of Conduct
sidebar_label: Code of Conduct
---

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at kent+coc@doddsfamily.us. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][http://contributor-covenant.org], version 1.4,
available at [http://contributor-covenant.org/version/1/4][http://contributor-covenant.org/version/1/4/]
16 changes: 12 additions & 4 deletions docs/website/contribute.md → docs/project/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ sidebar_label: Help us Improve
## Help improve the all-contributors documentation!

Pull Requests welcome for any level of improvement, from a small typo to new section, help us make the documentation better!
Thanks for your interest in the project!
Pull Requests welcome for any level of improvement, from a small typo to new section, help us make the project better

All the source code is available at [github.com/all-contributors/website](/~https://github.com/all-contributors/website/tree/master/docs)


## Editing Content

> **Pro Tip**: Every page has an _Edit_ button up the top, clicking this will take you straight to the GitHub source code for that page
Expand All @@ -23,5 +23,13 @@ Once on a file, click the 'pencil' icon to [easily edit the file inline](https:/
</div>


## Translation
Our translations are managed through crowdin. If you want to help contribute [please comment on this thread](/~https://github.com/all-contributors/all-contributors/issues/143) and I'll add you to the project
## Translations
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/all-contributors/localized.svg)](https://crowdin.com/project/all-contributors)

Our translations are managed through crowdin. You can help contribute by heading to [the crowdin project](https://crowdin.com/project/all-contributors) and suggesting translations.
If you like, [comment on this issue](/~https://github.com/all-contributors/all-contributors/issues/143) to let us know you're helping or if you have any queries!



## Add yourself as a contributor
To add yourself to the table of contributors, follow the [bot usage instructions](../bot/usage) ;).
34 changes: 34 additions & 0 deletions docs/project/implementations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
id: implementations
title: Who's using it?
sidebar_label: Who's using it?
---

This is a list of projects which have implemented the `all-contributors` specification. To add your project to this
list, please [edit this page](contribute)!

- [all-contributors/all-contributors](/~https://github.com/all-contributors/all-contributors)
- [sarbbottam/eslint-find-rules](/~https://github.com/sarbbottam/eslint-find-rules)
- [platinumazure/eslint-plugin-qunit](/~https://github.com/platinumazure/eslint-plugin-qunit)
- [djangocon/2016.djangocon.us](/~https://github.com/djangocon/2016.djangocon.us)
- [formly-js/ng-formly](/~https://github.com/formly-js/ng-formly)
- [kentcdodds/webpack-config-utils](/~https://github.com/kentcdodds/webpack-config-utils)
- [kentcdodds/p-s](/~https://github.com/kentcdodds/p-s)
- [kentcdodds/split-guide](/~https://github.com/kentcdodds/split-guide)
- [all-contributors/all-contributors-cli](/~https://github.com/all-contributors/all-contributors-cli)
- [kentcdodds/react-workshop](/~https://github.com/kentcdodds/react-workshop)
- [kentcdodds/rtl-css-js](/~https://github.com/kentcdodds/rtl-css-js)
- [ta2edchimp/opt-cli](/~https://github.com/ta2edchimp/opt-cli)
- [diegohaz/arc](/~https://github.com/diegohaz/arc)
- [jccguimaraes/atom-project-viewer](/~https://github.com/jccguimaraes/atom-project-viewer)
- [tutorship/tutorship](/~https://github.com/tutorship/tutorship)
- [Angular Medellin Meetup](/~https://github.com/angular-medellin/meetup)
- [React Medellin Meetup](/~https://github.com/react-medellin/meetup)
- [jmeas/redux-resource](/~https://github.com/jmeas/redux-resource)
- [render_async](/~https://github.com/renderedtext/render_async)
- [GitPoint](/~https://github.com/gitpoint/git-point)
- [ioof-holdings/redux-subspace](/~https://github.com/ioof-holdings/redux-subspace)
- [syt123450/giojs](/~https://github.com/syt123450/giojs)

**Note**: There are many projects not listed here. You'll probably be able to find more with this
[github search for .all-contributorsrc](/~https://github.com/search?utf8=%E2%9C%93&q=.all-contributorsrc+in%3Apath&type=Code&ref=searchresults)
54 changes: 19 additions & 35 deletions website/core/Footer.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,41 +10,25 @@ const React = require('react')
class Footer extends React.Component {
render() {
return (
<footer className="nav-footer" id="footer">
<section className="footer">
<div className="footer-icon">
<a href={this.props.config.baseUrl} className="nav-home">
{this.props.config.footerIcon && (
<img
src={
this.props.config.baseUrl +
this.props.config.footerIcon
}
alt={this.props.config.title}
width="58"
height="58"
/>
)}
</a>
</div>
<div className="footer-github">
<a href="/~https://github.com/all-contributors/all-contributors">GitHub</a>
<a
className="github-button"
href="/~https://github.com/all-contributors/all-contributors"
data-icon="octicon-star"
data-count-href="/facebook/docusaurus/stargazers"
data-show-count="true"
data-count-aria-label="# stargazers on GitHub"
aria-label="Star this project on GitHub"
>
Star
</a>
</div>
</section>
<section className="copyright">
{this.props.config.copyright}
</section>
<footer className="docs-footer">
<a href="/">
<img
className="docs-footer__logo"
src="/img/icons/logo-square-transparent.png"
alt="All Contributors"
/>
</a>
<a
className="github-button docs-footer__github-stars"
href="/~https://github.com/all-contributors/all-contributors"
data-icon="octicon-star"
data-count-href="/facebook/docusaurus/stargazers"
data-show-count="true"
data-count-aria-label="# stargazers on GitHub"
aria-label="Star All Contributors on GitHub"
>
Star All Contributors
</a>
</footer>
)
}
Expand Down
6 changes: 4 additions & 2 deletions website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@
"cli/usage",
"cli/configuration"
],
"Documentation": [
"website/contribute"
"Project": [
"project/contribute",
"project/code-of-conduct",
"project/whos-using-it"
]
}
}
1 change: 0 additions & 1 deletion website/siteConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ const siteConfig = {
{ href: "/~https://github.com/all-contributors/all-contributors", label: "GitHub" },
],
headerIcon: 'img/icons/logo-square-transparent.png',
footerIcon: 'img/icons/logo-square-transparent.png',
favicon: 'img/icons/favicon-32x32.png',
colors: {
primaryColor: '#0e0c33',
Expand Down
16 changes: 11 additions & 5 deletions website/static/css/docs.css
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,19 @@ article p img, article iframe {
display: inline-block;
}

.footer-github {
display: flex;
flex-direction: column;
.docs-footer {
text-align: center;
margin: 12px;
}

.footer-icon {
margin-right: 10px;
.docs-footer__logo {
height: 40px;
}

.docs-footer__github-stars {
position: relative;
bottom: 11px;
margin-left: 8px;
}

.fixedHeaderContainer {
Expand Down
7 changes: 4 additions & 3 deletions website/static/css/homepage.css
Original file line number Diff line number Diff line change
Expand Up @@ -212,17 +212,18 @@ p {

/*--Aloha--*/
.ribbon {
font-size: 16px !important;
font-size: 16px;
/* This ribbon is based on a 16px font side and a 24px vertical rhythm. I've used em's to position each element for scalability. If you want to use a different font size you may have to play with the position of the ribbon elements */
width: 300px;
position: absolute;
left: 0;
top: 80px;
background: #ea7068;
color: #fff;
text-align: centre;
text-align: center;
padding: 16px; /* Adjust to suit */
padding-left: 100px;
height: 52px;
font-weight:bold;
}

.ribbon a {
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions website/static/img/icons/logo-full.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/static/img/icons/logo-square.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 3 additions & 5 deletions website/static/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -172,11 +172,9 @@ <h1>Recognize All Contributors</h1>
/>
</div>
</div>
<div class="aloha">
<h1 class="ribbon">
<strong class="ribbon-content"><a href="https://www.jsconfhi.com/">Aloha JSconf Hawai'i!!</a></strong>
</h1>
</div>
<div class="ribbon">
<a href="https://www.jsconfhi.com/">Aloha JSconf Hawai'i!!</a>
</div>
<div class="wave"></div>
<div class="benefits">
<div class="container centred-content ">
Expand Down

0 comments on commit ff89015

Please sign in to comment.