Skip to content

Docs: Create a static site #2

@natalialuzuriaga

Description

@natalialuzuriaga

MENTOR

BRIEF DESCRIPTION

To provide more thorough and complete documentation on CMS code.json, we would like to create a static site with documentation similar to https://yml.publiccode.tools/index.html.

SCOPING

  • 1-2 weeks

SKILLS NEEDED

HTML/CSS/JS, Static Web Development, GitHub Pages, Documentation writing

REQUIRED DELIVERABLES

Make as clear of a step-by-step list as you can:

  1. Research metadata standards and how they are documented.
  2. Create structure and content for website. Identify sections/pages should be in the website. Some ideas are schema with explanation of each field, examples page, background/history pointing to legislation.
  3. Find any potential templates to use for static site, look into use of USWDS
  4. Develop website on this repository & ship

DESIRED DELIVERY WINDOW

  • June, July, or August

NOTES/INSPO

Very excited for this one 🥳

ACKNOWLEDGEMENTS

  • - Yes, I agree to spend file a project proposal ticket
  • - Yes, I agree this project falls within a 2 week or less (ideally less) scope of time
  • - Yes, I agree to spend an hour per week of office hours and 1x1 mentoring
  • - Yes, I agree to spend an hour at the end of the sprint for filling out a Retro Template

Metadata

Metadata

Assignees

No one assigned
    No fields configured for Feature.

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions