Migrate documentation across all EDA/KC repositories to Gatsby theme
Closed this issue · 1 comments
As https://gatsby-theme-carbon.now.sh/ is becoming the de facto standard for GitBook-like documentation, we need to migrate our existing MkDocs/Material-based documentation to the new Gatbsy documentation (that is not based on MkDocs).
This should ideally be done in two phases:
- Migrate over to Gatsby with as much fidelity to the existing documentation content.
- Update, prune, and curate the content in the new Gatsby-based GitBooks to more accurately reflect user experience and improve overall adoption. (this includes the potential removal of GitBooks content for a specific microservice and instead pointing back to
refarch-edaorrefarch-kcfor proper documentation)
Repositories include:
- refarch-eda
- refarch-kc
- refarch-kc-ui
- refarch-kc-ms
- refarch-kc-container-ms
- refarch-kstreams
- reefer-simulator
Additional issues for each individual repository should be created and linked from this issue to track overall progress.
This has begun and is currently underway. Based on additional conversation being done around documentation scope, we can mark this item complete and will create a new work item for doc refactoring across refarch-eda and refarch-kc.
refarch-eda will become the defacto high-level conceptual entry point gitbook, while refarch-kc will the the lower-level technical implementation gitbook. The individual gitbook publications that are associated with each individual microservice repository will be removed from the gh-pages publication and its content will be merged into either refarch-eda or refarch-kc to reduce the overall footprint and spread of our doc.
Closing this issue in favor of #36