substrate-docs
substrate-docs copied to clipboard
substrate-developer-hub
[Content] Pin docs to released versions
Content request
For the time being we will be considering the substrate in the latest polkadot-x.x.x-release branch the most stable. Docs should thus use these as their baseline and work with these.
Are you willing to help with this request?
Maybe (please specify)
Additionally, if possible it'd be great if users could switch to master as well as older previous-released versions easily – both stating that they are looking at an unsupported versions.
Didn't we actually decided to only have one doc page and that always points to master? To remove this entire versioning at all?
Didn't we actually decided to only have one doc page and that always points to master? To remove this entire versioning at all?
That is what you proposed and we are striving for eventually yes (although I don't understand the urge to remove archived versions altogether, why?).
But we are talking about different time lines here: even once we have mastered continuous releasing for substrate telling people to always work against master with potentially daily breaking changes might not be feasible as the main entry point for people to start with. Meanwhile we can already take steps into the direction that will dramatically improve the situation until we've figured out the other problems along the way. This isn't "either or", it's a "steps towards".
Having an unstable document site on something like a daily basis to learn from is highly problematic. While not many things from commit to commit, end users learning from these docs will have to update manually just to be able to continue. I am generally opposed to such a fluid environment.
The monthly cadence is presently what is used, and that is already a rather large time-suck for the docs&support team to maintain along with the many other versionings that need to be accounted for:
- Substrate itself
- Polkadot & Cumulus (& Canvas soon )
- Frontier
- .... more "Substrate Library Extensions"
- (Not directly here, but for the community) ORML and the like 3rd party pallets
These by definition do not move together, and cause us to need different versioning anyhow.
With #478 completed, it will be much easier to maintain docs moving forward, before even considering moving to anything faster this should be implemented. Still the issue of user experience needs to be considered here regardless.
I am leaning towards Polkadot release cadence (for now) - https://github.com/substrate-developer-hub/substrate-node-template/issues/260