Docs: Create a static site
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 35/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- css, html, javascript
- Domínio
- documentation, web-dev
Direção de pesquisa
Comece revisando o repositório e o site de documentação referenciado yml.publiccode.tools; em seguida, pesquise padrões de metadados e avalie templates de sites estáticos, incluindo o USWDS. Defina a estrutura e o conteúdo do site, abrangendo o schema, as explicações dos campos, exemplos e o contexto ou a legislação. O trabalho estará concluído quando o site de documentação estiver desenvolvido neste repositório e publicado.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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
- Linguagem predominante
- Sem dados de linguagem
- Estrelas
- 5
- Forks
- 2
- Merge médio
- 6d 17h
- PRs com merge (30d)
- 2
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Issues semelhantes
-
Refresh stale docsAberta
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 67/100
OpenCarControls/firmware#35 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 78/100
-
beginner-friendly category:fixtures community enhancement first-timers-only good first issue hacktoberfest help wanted low hanging fruit micro-contribution type: task up-for-grabs
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 85/100
Berserk-hub150/skillhawk#229 · 1 comentário ·
Mantenedores costumam responder em até 8 dias
-
area:docs kind:docs-drift
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
InauguralSystems/EigenScript#1887 ·
Mantenedores costumam responder em até 1 dia