hackforla / hackforla/knowledgebase-content

Create a Guide/Template: Documentation Technologies

Abierto
#145 3 comentarios 0 reacciones 0 asignados Ver en GitHub
Complexity: Missing CoP label: checked CoP label: shortcuts added CoP: Engineering CoP: Product feature : guide creation milestone: missing Phase: 1 - Gather Examples Solo Ready for Bonnie Triage size: missing status: 1.1 needs wiki examples status: 1.2 needs issues examples status: 1.3 needs project board examples status: 1.4 needs slack examples
Lenguaje dominante
Sin datos de lenguaje
Estrellas
2
Forks
1
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

### Overview
We need to create a guide to making a storage for your documentation, therefore we will write a guide discussing different documentation technologies that are available.

### Action Items
The phases in the guide-making process are listed below. Each phase displayed in blue is linked to a wiki page with instructions on how to complete that phase. Open the wiki page in a new tab, copy the instructions for each part into the section labeled 'Tasks' at the bottom of this issue, and complete each task listed.
- [ ] [Gather Examples Solo](https://github.com/hackforla/guides/wiki/How-to-Gather-Examples:-Solo) (open in a new tab)
- [ ] [Gather Examples Collaboratively](https://github.com/hackforla/guides/wiki/Phase-2-%E2%80%90-Gather-Examples-Collaboratively)
- [ ] [Create a Guide Draft](https://github.com/hackforla/guides/wiki/How-to-Draft-a-Guide)
- [ ] If needed, create a template
- [ ] [Have your guide peer reviewed](https://github.com/hackforla/guides/wiki/Peer-Reviews-for-Guides)
- [ ] [Present your guide for leadership review](https://github.com/hackforla/guides/wiki/Submitting-Your-Guide-for-Leadership-Review)
### Resources/Instructions

Google Drive Folder for this Guide’s documents and shortcuts [0145 [DRAFT] Documentation Technologies ](https://drive.google.com/drive/folders/1qRmqiftHcz8Jn8Q417QlfV0SOQBVUFx3)
There are many different free documentation management systems. We use two at Hack for LA
1. GitHub Wiki: To use when your wiki is small
2. MkDocks: As your wiki grows it can become unmanageable. At this point we recommend asking for a documentation repo and installing MK docks.
1. check the project People Depot for examples
- GitHub Wiki: https://github.com/hackforla/peopledepot/wiki
- MkDocks wiki: https://hackforla.github.io/peopledepot/

### Projects to Check
### Tasks
- [ ] This is where you will copy instructions from the wiki page for the step you are currently on.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza con las instrucciones de la wiki enlazada para recopilar ejemplos, redactar, realizar la revisión por pares y llevar a cabo la revisión por parte del liderazgo; después, inspecciona la carpeta de Google Drive en busca de materiales existentes para la guía. La guía debe comparar las tecnologías de documentación disponibles, utilizar los ejemplos de GitHub Wiki y MkDocks indicados, y completar las fases de revisión y liderazgo.

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

Evaluación

Stack tecnológico
github
Área
documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.