Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the actions to deploy the docs site #79

Open
mkbreuningIOHK opened this issue Feb 20, 2024 · 1 comment
Open

Document the actions to deploy the docs site #79

mkbreuningIOHK opened this issue Feb 20, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@mkbreuningIOHK
Copy link
Contributor

mkbreuningIOHK commented Feb 20, 2024

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:

  • version
  • environment

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

I propose that

  • a guidance is added in the readme file.
  • the help on the screen is modified from
    - 'Version to deploy, e.g. v1.0.0' to 'Docs version to deploy, e.g v1.76.1'
    - 'Environment to trigger update on' to 'Target environment: staging or production'

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

@mkbreuningIOHK mkbreuningIOHK added the documentation Improvements or additions to documentation label Feb 26, 2024
@essbante-io
Copy link
Contributor

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants