diff --git a/src/_includes/nav/copyright-back-to-top.njk b/src/_includes/nav/copyright-back-to-top.njk index 036ad486b..5af6dc691 100644 --- a/src/_includes/nav/copyright-back-to-top.njk +++ b/src/_includes/nav/copyright-back-to-top.njk @@ -1,6 +1,6 @@

- © 2013–2020 The Accessibility Project. APLv2. Sitemap. + © 2013–2021 The Accessibility Project. APLv2. Sitemap.

Powered by Eleventy, Netlify, and GitHub. diff --git a/src/contributing-guidelines.njk b/src/contributing-guidelines.njk index 5a803f4f9..ff8e80979 100755 --- a/src/contributing-guidelines.njk +++ b/src/contributing-guidelines.njk @@ -27,118 +27,19 @@ templateClass: template-generic About this site

- Following is information about how the site operates. Instructions on how to get the site running locally on your computer can be found in the README. + Following are guidelines for submitting content for our site. Instructions on how to get the site running locally on your computer can be found in the README.

-

- Git and GitHub -

-

- The A11Y Project is an Open Source project. It uses Git and GitHub to handle publishing new content and features, as well as coordinating maintenance. -

-

- People working on more sophisticated aspects of the site (new features, bug fixes, etc.) are expected to have at least some familiarity with version control, GitHub's key functionality, and using feature branches to work locally. -

-

- If you are looking for a place to get started learning about Git and contributing to an Open Source project, Egghead.io offers a great introductory course. -

-

- Forking -

-

- To submit updates and changes to The A11Y Project, you will first need to Fork the repository. -

-

- Forking will create a copy of the repository on your GitHub account. This will allow you to make changes on your copy and suggest incorporating them into The A11Y Project's repository in the form of a Pull Request. -

-

- If you do not plan on working on The A11Y Project for an extended period of time you can delete your Fork of the repository after your Pull Request has been merged without endangering our copy. -

-

- Build process -

-

- This project uses Eleventy to convert project files into a website that a browser can read and display. You'll need to make sure you've run all the commands in our README to get Eleventy working. -

-

- Tatiana Mac has a great beginner's guide to Eleventy, if you are looking for a good introduction. -

-

- Any changes you save will cause the local version of the site to recompile. The browser tab that has your local instance of the site will automatically refresh, allowing you to preview your edits. -

-

- Important branches -

-

- main is the production branch. This is the live website. -

-

- If you have a feature request, we suggest first filing an Issue to discuss it (please read how to report an issue first). Once that feature has been approved you can start coding! Create a new feature branch from main, and name it something that references the feature you'll be working on. For example a feature to increase the site's type size could be: increase-font-size. -

-

- A list of all active branches is available. -

-

- Editing files -

-

- This site uses specific kinds of files to help run the site efficiently. Eleventy will take these files and compile them into HTML, CSS, and other browser-friendly code. -

-

- Please make all edits in these files, and not the compiled code. If you edit the compiled code it will be overwritten the next time any file is saved and all your hard work will be lost! -

-

- Some of the main files this site uses are: -

-

- Markdown -

-

- Markdown is a lightweight markup language that makes writing easier. We use it mainly to organize our blog posts. It uses .md files and compiles into HTML. -

-

- Nunjucks -

-

- Nunjucks is a templating language for HTML that uses JavaScript. We use it to create the templates used to build the site. It uses .njk files and compiles into HTML. -

-

- Sass -

-

- Syntactically Awesome Style Sheets (Sass) is an extension of the CSS language that adds many helpful features. Using it helps keep our site's visual presentation consistent. It uses .scss files and compiles into CSS. -

-

- JSON -

-

- JavaScript Object Notation (JSON) is a human-readable way to store structured data. We use it to store information such as resources and commonly-repeated information. It uses .json files. -

-

- SVG -

-

- Scalable Vector Graphics (SVG) is a vector-based image format that makes crisp images with a small file size. It uses the .svg file format and can be either declared inline, or linked to as an image. -

-

- YAML -

-

- YAML Ain't Markup Language (YAML) is a human-readable markup language that is good for writing structured data. This structured data is used specifically for posts and Eleventy page templates. -

- -
-

Submitting content

- In the spirit of Open Source, The A11Y Project tries to only promote content that is free, or has a low barrier to entry. We're not too keen on partnership deals or promotions. + In the spirit of Open Source, The A11Y Project tries to only promote content that is free, or has a low barrier to entry.

Content style guide

- The A11Y Project has a Content Style Guide to help our content have a consistent voice and tone. Please take a moment to familiarize yourself with it. + The A11Y Project has a Content Style Guide to help our content have a consistent voice and tone. Please familiarize yourself with it before writing content for us.

Posts @@ -150,7 +51,7 @@ templateClass: template-generic Have an idea for a post? Great! We'd love to know what you want to contribute!

    -
  1. Search to make sure someone hasn't claimed the post already.
    2. +
  2. Search our open GitHub Issues to make sure someone hasn't claimed the post already.
  3. Claim a post by starting a new Issue with "Post: Your title" as the Issue title. This will help us keep track of who is working on what. The final, published title can be different from the Issue name.

@@ -194,17 +95,6 @@ templateClass: template-generic

  • Promote the post on our Twitter and LinkedIn social media accounts.
  • Feature you in our weekly newsletter.
    • -

    - Evaluation -

    -

    - When we evaluate suggested content, we consider the following things:

    -

    Resources

    @@ -220,45 +110,156 @@ templateClass: template-generic

    We share links about accessibility, inclusivity, design, and development on Twitter and LinkedIn. If you would like to submit a link for sharing, please contact us and include the link in your message.

    + + + +
    + +

    + Evaluation +

    +

    + Process +

    +

    When you submit content to us, one or more of The A11Y Project maintainers will review it and provide feedback, if it is necessary. These reviews happen on GitHub or in email.

    +

    + When we evaluate suggested content, we consider the following things:

    + +

    A maintainer may reach out to someone submitting content to request clarification or further information.

    +

    + Rejection +

    +

    + Project maintainers may elect to not accept your submission if they feel it is not in line with the site's goals. This will be handled on a case-by-case basis. +

    +

    + Unacceptable content +

    - We do not share the following: + The following content is not allowed on the website:

    -

    - Events -

    +

    + Promotions, partnership deals, and SEO scams +

    - The A11Y Project used to list webinars, regional events, and meetups. We no longer support this feature. If you are interested in finding an accessibility-related group near you, please check our Meetups section in Resources. + We are not interested in quid pro quo schemes to boost your site's SEO ranking. We are also not interested in backlink, partnership, and affiliate linking programs.

    -

    - Patterns +

    + Plagiarism +

    +

    + The A11Y Project does not condone plagiarism. We check submitted content for stolen phrasing and assets when submitted. People found plagiarizing content will be asked to stop contributing to the website. +

    + +
    + +

    + Git and GitHub +

    +

    + The A11Y Project is an Open Source project. It uses Git and GitHub to handle publishing new content and features, as well as coordinating maintenance. +

    +

    + People working on more sophisticated aspects of the site (new features, bug fixes, etc.) are expected to have at least some familiarity with version control, GitHub's key functionality, and using feature branches to work locally. +

    +

    + If you are looking for a place to get started learning about Git and contributing to an Open Source project, Egghead.io offers a great introductory course. +

    +

    + Forking

    - The A11Y Project used to list code patterns. We no longer support this feature. If you are interested in learning about accessible implimentations of common User Interface elements, please consult the WAI-ARIA Authoring Practices. + To submit updates and changes to The A11Y Project, you will first need to Fork the repository.

    -

    - Promotions, partnership deals, and SEO scams +

    + Forking will create a copy of the repository on your GitHub account. This will allow you to make changes on your copy and suggest incorporating them into The A11Y Project's repository in the form of a Pull Request. +

    +

    + If you do not plan on working on The A11Y Project for an extended period of time you can delete your Fork of the repository after your Pull Request has been merged without endangering our copy. +

    +

    + Build process

    - We are not interested in quid pro quo schemes to boost your site's SEO ranking. We are also not interested in backlink, partnership, and affiliate linking programs. + This project uses Eleventy to convert project files into a website that a browser can read and display. You'll need to make sure you've run all the commands in our README to get Eleventy working.

    -

    - Plagiarism +

    + Tatiana Mac has a great beginner's guide to Eleventy, if you are looking for a good introduction. +

    +

    + Any changes you save will cause the local version of the site to recompile. The browser tab that has your local instance of the site will automatically refresh, allowing you to preview your edits. +

    +

    + Important branches

    - The A11Y Project does not condone plagiarism. We check submitted content for stolen phrasing and assets when submitted. People found plagiarizing content will be asked to stop contributing to the website. + main is the production branch. This is the live website.

    -

    - Rejection +

    + If you have a feature request, we suggest first filing an Issue to discuss it (please read how to report an issue first). Once that feature has been approved you can start coding! Create a new feature branch from main, and name it something that references the feature you'll be working on. For example a feature to increase the site's type size could be: increase-font-size. +

    +

    + A list of all active branches is available. +

    +

    + Editing files

    - Project maintainers may elect to not accept your submission if they feel it is not in line with the site's goals. This will be handled on a case-by-case basis. + This site uses specific kinds of files to help run the site efficiently. Eleventy will take these files and compile them into HTML, CSS, and other browser-friendly code. +

    +

    + Please make all edits in these files, and not the compiled code. If you edit the compiled code it will be overwritten the next time any file is saved and all your hard work will be lost! +

    +

    + Some of the main files this site uses are: +

    +

    + Markdown +

    +

    + Markdown is a lightweight markup language that makes writing easier. We use it mainly to organize our blog posts. It uses .md files and compiles into HTML. +

    +

    + Nunjucks +

    +

    + Nunjucks is a templating language for HTML that uses JavaScript. We use it to create the templates used to build the site. It uses .njk files and compiles into HTML. +

    +

    + Sass +

    +

    + Syntactically Awesome Style Sheets (Sass) is an extension of the CSS language that adds many helpful features. Using it helps keep our site's visual presentation consistent. It uses .scss files and compiles into CSS. +

    +

    + JSON +

    +

    + JavaScript Object Notation (JSON) is a human-readable way to store structured data. We use it to store information such as resources and commonly-repeated information. It uses .json files. +

    +

    + SVG +

    +

    + Scalable Vector Graphics (SVG) is a vector-based image format that makes crisp images with a small file size. It uses the .svg file format and can be either declared inline, or linked to as an image. +

    +

    + YAML +

    +

    + YAML Ain't Markup Language (YAML) is a human-readable markup language that is good for writing structured data. This structured data is used specifically for posts and Eleventy page templates.

    @@ -351,6 +352,33 @@ templateClass: template-generic 

    updated_by: editor_name
 last_updated: yyyy-mm-dd
    + +

    + Content we no longer support +

    +

    Following is content we’ve removed from the website and no longer support:

    +

    + Events +

    +

    + The A11Y Project used to list webinars, regional events, and meetups. We no longer support this feature. If you are interested in finding an accessibility-related group near you, please check our Meetups section in Resources. +

    +

    + Patterns +

    +

    + The A11Y Project used to list code patterns. We no longer support this feature. If you are interested in learning about accessible implimentations of common User Interface elements, please consult the WAI-ARIA Authoring Practices. +

    +

    + Who to follow +

    +

    + The A11Y Project used to list people to follow in the digital accessibility space. We no longer support this feature. Bruno Pulis maintains a list of notable people, companies and organizations, and meetups that contribute to digital accessibility and open standards. +

    + + +
    +

    License