reflexivesecurity / reflex-docs

Documentation for Reflex
https://docs.cloudmitigator.com/
Mozilla Public License 2.0
4 stars 0 forks source link

Figure out how to manage docs versioning for separate components #2

Open mcbanderson opened 4 years ago

mcbanderson commented 4 years ago

Since Reflex has numerous independently versioned components, we need to figure out how we're going to handle this in terms of the docs. Do we have fully separate documentation for each component which reflects the version of that component? Do we have fully unified docs which somehow reflects the different version of each component? Or something in-between?

My current though on this is to have docs.cloudmitigator.com be our universal docs page (which will be versioned), and subdomains for each individual project, ie reflex.docs.cloudmitigator.com (which will all also be separately versioned).

A potential tool for helping manage the doc versions: https://github.com/sphinx-contrib/sphinxcontrib-versioning

rot26 commented 4 years ago

@mcbanderson is this for documenting api docs for the individual components?

mcbanderson commented 4 years ago

This is basically an overarching issue for how we handle versions for all our documentation.

It's common for many OSS projects to have separate docs pages for each major version, if not each minor version. For example the Laravel documentation (https://laravel.com/docs/7.x) has a dropdown in the top right corner that let's you select documentation for a specific version of the project.

This is not a huge priority for us at the moment, since we'll only have one major version that exists. But we'll need to figure out how to handle this going forward so that we're still providing accurate documentation for all supported versions.