Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Create a static site #2

Open
4 tasks done
natalialuzuriaga opened this issue Feb 4, 2025 · 0 comments
Open
4 tasks done

Docs: Create a static site #2

natalialuzuriaga opened this issue Feb 4, 2025 · 0 comments

Comments

@natalialuzuriaga
Copy link
Contributor

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

1 participant