refactor: split docs between hexaforge and cpin #56
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
this-is-tobi
requested review from
Baboulinet-33
and removed request for
Baboulinet-33
this-is-tobi
added
enhancement
this-is-tobi
force-pushed
the
refactor/split-docs
branch
from
861fff1
to
01b81d3
Compare
this-is-tobi
force-pushed
the
refactor/split-docs
branch
from
01b81d3
to
780e333
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Quel est le comportement actuel ?
La documentation de la plateforme open source ainsi que la documentation de l'offre de services sont mélangées.
Quel est le nouveau comportement ?
Une image docker est désormais générée pour chaque type de documentation dans l'optique de les héberger sur 2 domaines différents.
Cette PR introduit-elle un breaking change ?
Oui.
Autres informations
Il existe désormais 2 dossiers de documentation :
cloud-pi-nativepour la documentation liée à l'offre de service.hexaforgepour la documentation liée à la plateforme.J'ai pour l'instant laissé l'ancien dossier
docspour qu'on puisse piocher dedans les docs existantes et les répartir entre les désormais 2 sites. J'ai déjà commencé à proposer une structure des sites que vous pouvez voir dans :hexaforge/index.mdhexaforge/.vitepress/sidebar.jsoncloud-pi-native/index.mdcloud-pi-native/.vitepress/sidebar.jsonJ'ai aussi commencez à réécrire la CI/CD pour build les 2 images, je finirai plus tard ça n'est pas le plus long / dur.
Pour lancer les sites de doc en mode dev vous pouvez (je vous invite à regarder en détail le
package.jsonpour voirs tous les scripts dispos) :