DSACMS / DSACMS/gov-codejson

Docs: Create a static site

Open
#2 0 comments 0 reactions 0 assignees View on GitHub
summer2024
Dominant language
No language data
Stars
5
Forks
2
PR merge metrics
No merged PRs in 30d

Description

## MENTOR
- @natalialuzuriaga
- USDC SWE Fellow, OSPO
- Slack

## 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
- [X] - Yes, I agree to spend file a project proposal ticket
- [X] - Yes, I agree this project falls within a 2 week or less (ideally less) scope of time
- [X] - Yes, I agree to spend an hour per week of office hours and 1x1 mentoring
- [X] - Yes, I agree to spend an hour at the end of the sprint for filling out a Retro Template

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.