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.

Sign up for GitHub

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

Jump to bottom

Documentation API Redocly (à la Forem de Dev.to) #11

Open
1 of 2 tasks
adriens opened this issue Jul 13, 2021 · 1 comment
Open
1 of 2 tasks

Documentation API Redocly (à la Forem de Dev.to) #11

adriens opened this issue Jul 13, 2021 · 1 comment
Assignees
@HakumenNC
Labels
CI communication documentation Improvements or additions to documentation

Comments

@adriens
Copy link
Collaborator

adriens commented Jul 13, 2021 •
edited by HakumenNC
Loading

Contexte

Actuellement, la doc est uniquement en Swagger : il est temps de créer une doc belle et efficace qui mettre en valeur l'API.

Actions

  • Proposer le yaml qui permet de faire le docker compose qui tourne en local sur poste de dev : l'API et la doc
  • A chaque release, pousser la doc statique générée sur gh-pages, grâce à l'image docker et via une GH Actions

Resources
@adriens adriens added documentation Improvements or additions to documentation communication CI labels Jul 13, 2021
@adriens adriens pinned this issue Jul 13, 2021
HakumenNC added a commit that referenced this issue Aug 15, 2021
@HakumenNC
docs(controller): Add swagger/openAPI annotations for swagger/redocly #…
a791d9c 
…11
@HakumenNC
Copy link
Collaborator

Build image using jib 03f1594

HakumenNC added a commit that referenced this issue Sep 5, 2021
@HakumenNC
feat(redoc): Add docker-compose file and update docs content #11
634ecce
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@HakumenNC HakumenNC

Labels
CI communication documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@HakumenNC @adriens