sodafoundation / documentation

Documentation for SODA Foundation and SODA Core projects. Covers code for doc site generation.
https://docs.sodafoundation.io/
MIT License
46 stars 220 forks source link

Can the SODA Documentation website be used as a single source of truth for all the documentations across all SODA organizations? #269

Closed anvithks closed 1 year ago

anvithks commented 1 year ago

Issue/Feature Description: Display the documentation for all SODA projects, across GitHub organizations, under one website, https://github.com/sodafoundation

Why this issue to fixed / feature is needed(give scenarios or use cases): Currently the SODA documentation website https://docs.sodafoundation.io provides the documentation for the SODA Framework projects that are hosted under the GitHub organization https://github.com/sodafoundation.

With the addition of SODA CDM Organization and the SODA Lake Organization, any new project that is added under these orgs would need a documentation website. Having multiple documentation websites will lead to fragmentation and a maintenance nightmare.

To avoid this it would be helpful if all the documentation for all SODA projects can be displayed via https://docs.sodafoundation.io.

One possible solution is to use Hugo modules and serve any content from other orgs as Hugo modules to the main website.

How to reproduce, in case of a bug:

Other Notes / Environment Information: (Please give the env information, log link or any useful information for this issue)