mojaloop / project

Repo to track product development issues for the Mojaloop project.
Other
24 stars 15 forks source link

[docs 2.0] - automate the versioning of docs #2607

Open lewisdaly opened 2 years ago

lewisdaly commented 2 years ago

Goal:

As a community member

I want to be able to browse past versions of the docs

so that I can find the docs that are for a specific version of mojaloop

Acceptance Criteria:

Complexity: <High|Medium|Low> > A short comment to remind the reason for the rating

Uncertainty: <High|Medium|Low> > A short comment to remind the reason for the rating


We now have some features in the vuepress based docs to be able to display multiple versions of the docs at once.

The challenge is figuring out when to version these docs and what to version them with... should they be tied to helm releases?

Tasks:

Done

Pull Requests:

Follow-up:

Dependencies:

Accountability:

lewisdaly commented 2 years ago

We have some basic docs versioning automation set up, so that every push to master will deploy the latest working changes.

I think for archiving 'old versions' we can either create a manual release each time a new helm version is released, so our docs follow along with the helm versioning scheme.