hyperledger / identus-docs

Documentation website for the Identus Platform
https://hyperledger.github.io/identus-docs/
Apache License 2.0
10 stars 4 forks source link

Document the actions to deploy the docs site #79

Open mkbreuningIOHK opened 7 months ago

mkbreuningIOHK commented 7 months ago

If you go to the tab 'Actions', there is no explanation to know what are the parameters and options to the deployment flow.

There are 2 parameters to the deployment flow:

There is no guideline on what can be chosen for those two fields.

I propose that

The source file is found here: https://github.com/input-output-hk/atala-prism-docs/blob/main/.github/workflows/deployment.yml

essbante-io commented 4 months ago

@mkbreuningIOHK is this still needed? I believe the deployment is documented in a .doc and moved to the handbook.

To deploy the documentation into production, Find the portal version of the Documentation Portal from the latest atala-releases.md file. In atala-prism-docs, run the workflow. To deploy it, click the Run Workflow button and set the "version to deploy" with the portal version and set the "Environment to trigger update on" value to "production" Click the green button. To check if the right version was deployed, go to the public site, https://docs.atalaprism.io/, and check that the Agent API version is the one that is found in the atala-releases.md same file you used in the step 1.