Steps for contributing to the 2024 content redesign

Here’s how CivicActioners can contribute to the content redesign of accessibility.civicactions.com.

Find a page to edit

1. Visit the Content redesign sheet to find a page to update on the 🗺️ Content plan tab.
2. Click over to the 🧑‍💻 Editors tab and insert a row to your name (Ctrl + click → Insert 1 row above/below → @yourname).
3. Back on 🗺️ Content plan select your name in the Editor column for the page you want to take (the row will turn yellow).

Prepare for editing

4. Review the Recommendations column to for suggestions on how to improve the page.
5. Click through to the page from the Audit address column.
6. Review the page and then scroll to the bottom and click “Help improve this page”.
7. If you are planning to edit in Google Docs, copy the title and description from the metadata block at the top of the *.md page you are viewing and paste into your new document. These should be considered for update and review as well.
8. You may like to paste the recommendations for your page at the top of your document too, as a guide.
9. Most recommendations suggest a format of Guide or Topic for your page. Learn more about what we expect for each format, and find example pages, in the Accessibility site content style guide.

Edit your page

10. Edit the content of your page:
    • Be sure to include the title and description:
      • the content of title appears in both <h1> and <title> and can’t be separated at this time
      • the content of description appears in <meta name="description"> which is important for search results
    • Ensure that you update the page’s structure according to the Format instructions.
    • Edit the main content according to the Recommendations.
    • Note that these are suggestions, so if you want to go a different way with your page edits, that’s fine. The team is happy to discuss in the #accessibility channel if you have questions or want some guidance.

Send your page for review

11. When you are ready to share your edits, please tag Adrian or Jordan (design) to review your Google doc or commit.
12. Update your draft with any changes and then ask Marissa (marketing) to review.
13. Incorporate any changes.

Publish your changes

14. Submit a pull request to update your page:
    • If you have drafted your changes in Google Docs, you will need to Edit the page in GitHub and use Markdown to update it to match your your draft.
    • You can do this by going to the original page, and clicking on “Help improve this page”.
    • Use the Preview tab to see how your edits will render.
    • Then commit your changes and submit a pull request.