This repo contains the contents for our docs deployed here.
The website is built using Docusaurus 2.
The Documentation is an ecosystem tool, we welcome everybody to collaborate and improve it! See the contributing page for details.
Releases to production are managed through the creation of a tagged version.
This step-by-step guide will walk you through getting ready for the deployment.
- Create a Pull Request to merge
devbranch onto themainbranch, ask code maintainers to review and approve the PR - Once merged, create a tagged version in the form of
vMayor.Minor.Patch, wait for the CIs to run, the CI will craft a Github release automatically containing the release notes, check the release out in releases - Go to Actions page, search for
Manual deployment to production, here the link.- click on
Run workflow, this will open a drop-down menu - Set
use workflow from main(it doesn't perform any actions on our CIs, but Github is still asking for a proper value) - Provide the version to deploy in the form of
vMayor.Minor.Patch - refresh the page, a new job will be marked as running, enter the job to check the logs out
- click on
- A notification is sent on Slack to the DevOps team containing the project being deployed, the version and the name of the user who triggered the action
Some content in this site was adapted or inherited from the work done by Andrew, Igor and team on the development of xDai. We thank them for the great job done!