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

Ajout de docsify pour publier la doc technique #1137

Closed
wants to merge 1 commit into from
Closed

Ajout de docsify pour publier la doc technique #1137

wants to merge 1 commit into from

Conversation

kolok
Copy link
Contributor

@kolok kolok commented Dec 13, 2024

Description succincte du problème résolu

Maintenant que la doc technique est officiellement sur github, Docsify aide à la publication à à la naivation dansla doc

2024-12-13.10.37.45.mp4

Question ouverte :

  • Est-ce qu'on veut publier cette doc sur tous les environnement ou laisser cette doc en environnement de développement uniquement ?

Notes

Type de changement :

  • Bug fix
  • Nouvelle fonctionnalité
  • Mise à jour de données / DAG
  • Les changements nécessitent une mise à jour de documentation
  • Refactoring de code (explication à retrouver dans la description)

Auto-review

Les trucs à faire avant de demander une review :

  • J'ai bien relu mon code
  • La CI passe bien
  • En cas d'ajout de variable d'environnement, j'ai bien mis à jour le .env.template
  • J'ai ajouté des tests qui couvrent le nouveau code

Comment tester

En local / staging :

@kolok kolok requested a review from a team as a code owner December 13, 2024 08:19
@kolok kolok requested review from fabienheureux and maxcorbeau and removed request for a team December 13, 2024 08:19
Copy link
Member

@fabienheureux fabienheureux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Je voudrais bien qu'on en reparle de vive voix, dans les projets python on trouve plus souvent sphinx / readthedocs, je suis pas contre docsify dans l'absolu mais je trouve dommage d'ajouter un outil de l'écosystème javascript sachant qu'on a une stack quasi full python

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Déplacement du tag favicon dans core car j'en avait besoin dans la doc et il est viable pour toutes nos appications

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Déplacement dans techdocs et ré-écriture là-bas :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants