Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Desplegar un sitio de documentacion en gh-pages cuando creamos nuevo proyecto #1414

Closed
unjust opened this issue Jun 23, 2023 · 2 comments
Closed
Assignees
Labels
help wanted Extra attention is needed idea Ideas, sugerencias, comentarios generales y feedback

Comments

@unjust
Copy link
Contributor

unjust commented Jun 23, 2023

Problema: Cuando agregamos contenido al READMEs y documentacion de los proyectos, puede ser mas dificil a navegar/leerlo para las estudiantes. No es muy user-friendly.

Solucion: Desplegamos un sitio de documentaction con cada proyecto , usando una herramienta como https://docusaurus.io/

Seria bueno experimentar con eso, quiza con un flag --experimental o --createDocs hasta que estamos seguro que es una mejora. Podemos lanzar eso con este PR por ejemplo #1375 .

Ejemplo crudo https://comun-radio.github.io/DEV106-burger-queen-api/


Update:

En lugar de automatizar algo experimaental al principio, podemos hacer un prueba manual con markdown links usando la idea de @Davichobits

  • Hacemos estilos para la interfaz parece mas
  • El repo de docs seria en la org Laboratoria
  • Eseguramos que los docs de apoyo tipo hitos o guias estan dentro una carpeta se llama /docs en los proyectos
@unjust unjust added help wanted Extra attention is needed idea Ideas, sugerencias, comentarios generales y feedback labels Jun 23, 2023
@unjust unjust self-assigned this Jun 23, 2023
@unjust
Copy link
Contributor Author

unjust commented Jun 26, 2023

Mejor ejemplo, pero aun manual https://davichobits.github.io/demo-mdlinks/
Pensamos podemos hacer algo manualmente para probar con el primer cohort con un MVP rapido, y de ahi si queremos quedar con eso, hacerlo automatizado.

Algunas configuraciones que podemos agregar a tu demo @Davichobits:

 { 
    baseUrl: repoName,
    projectName: repoName,
    organizationName: 'Laboratoria',
  };

He revisado como hacerlo y puedo ayudar!

@Davichobits
Copy link
Contributor

Para que el proyecto esté dentro de Laboratoria, debería crear un nuevo proyecto dentro de bootcamp?

@unjust unjust added this to the v8.5.0 Follow up C# milestone Mar 7, 2024
@unjust unjust modified the milestones: v8.6.0 , v8.7.0 Apr 12, 2024
@unjust unjust removed this from the v8.7.0 milestone May 16, 2024
@unjust unjust closed this as completed Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed idea Ideas, sugerencias, comentarios generales y feedback
Projects
None yet
Development

No branches or pull requests

2 participants