DSACMS / DSACMS/gov-codejson

Docs: Create a static site

Abierto
#2 0 comentarios 0 reacciones 0 asignados Ver en GitHub
summer2024
Lenguaje dominante
Sin datos de lenguaje
Estrellas
5
Forks
2
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

## 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

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.