Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Docs: Create a static site

Abierto
#2 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
css, html, javascript
Área
documentation, web-dev

Línea de trabajo

Comienza revisando el repositorio y el sitio de documentación yml.publiccode.tools referenciado; después, investiga los estándares de metadatos y evalúa plantillas para sitios estáticos, incluido USWDS. Define la estructura y el contenido del sitio, abarcando el esquema, las explicaciones de los campos, ejemplos y contexto o legislación. El trabajo estará terminado cuando el sitio de documentación esté desarrollado en este repositorio y publicado.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

summer2024

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

  • - 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
Lenguaje dominante
Sin datos de lenguaje
Estrellas
5
Forks
2
Sin PR fusionados en 30 d

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de DSACMS/gov-codejson

Todos los issues de DSACMS/gov-codejson

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.