Source code

The Docusaurus source code can be found in the docs/ folder.

Deployment

https://magma.github.io/magma

• The Docusaurus is deployed to https://magma.github.io/magma.
• :warning: Accessing https://magma.github.io/ will result in a 404. One point where this is configured is in the respective docusaurus-workflow.yml. However, there might be more duplicated configurations somewhere in the JavaScript code.
• There is a redirect from the old URL, https://docs.magmacore.org, to the current one
• The deployment seems to have the base URL hard coded somewhere, because the search always provides links to https://docs.magmacore.org/ and not itself. However, "normal" navigation works fine. After the DNS redirect this works fine.

Github action workflows

https://github.com/magma/magma/blob/master/.github/workflows/docs-workflow.yml:

This workflow is only a code analysis workflow doing a markdown lint check and an insync check for auto-generated files. It does not deploy anything.

https://github.com/magma/magma/blob/master/.github/workflows/docusaurus-workflow.yml:

This workflow will prepare the Docusaurus for deployment. I.e. it will

• change the directory structure according to the needs of Docusaurus and
• execute a JavaScript yarn command to build the page and copy it over to root of the gh-pages branch.

https://github.com/magma/magma/actions/workflows/pages/pages-build-deployment

• This workflow will finally deploy the content from the gh-pages branch to the production environment at https://magma.github.io/magma.
• This is an automatic workflow managed by Github. There does not exist any yaml file for this workflow in the repository. The configuration for this workflow can be found at https://github.com/magma/magma/settings/pages.