Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • A a11yproject.com
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 40
    • Issues 40
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 10
    • Merge requests 10
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • The A11Y Project
  • a11yproject.com
  • Merge requests
  • !640

Documentation updates

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Byte Blaze requested to merge documentation-updates into gh-pages Aug 24, 2018
  • Overview 23
  • Commits 13
  • Pipelines 0
  • Changes 3

This PR addresses issues brought up in https://github.com/a11yproject/a11yproject.com/issues/636 and https://github.com/a11yproject/a11yproject.com/issues/631#issuecomment-414445175.

It is a significant overhaul of our README.md and CONTRIBUTING.md docs. It also builds off of the STYLE_GUIDE.md work started by @missmatsuko.

The big-picture goals of this PR are to:

  • Update site installation instructions and provide some high-level troubleshooting.
  • Provide information about what technology powers the site and how to work with it.
  • Move all contribution-related content into a single document.
  • Establish authoring standards for the site.
  • Outline the expected contribution workflow.

The Files Changed view is tough to parse, so here's links to the updated documents that are easier to read:

  • README.md
  • CONTRIBUTING.md
  • CONTENT_STYLE_GUIDE.md
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: documentation-updates