Docs: Create a static site
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- css, html, javascript
- Domain
- documentation, web-dev
Research direction
Start by reviewing the repository and the referenced yml.publiccode.tools documentation site, then research metadata standards and evaluate static-site templates, including USWDS. Define the site structure and content, covering the schema, field explanations, examples, and background or legislation. Done means the documentation site is developed in this repository and shipped.
Written by the indexing model from the issue text.
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:
- Research metadata standards and how they are documented.
- 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.
- Find any potential templates to use for static site, look into use of USWDS
- 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
- Dominant language
- No language data
- Stars
- 5
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from DSACMS/gov-codejson
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
DSACMS/gov-codejson#29 ·
-
Metadata Converters Open
Difficulty 5/5 Over a week Newbie friendliness 25/100
DSACMS/gov-codejson#4 ·
All issues in DSACMS/gov-codejson
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100