Skip to content

Commit

Permalink
Describe staging vs prod for tutorials deploys (#1220)
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric-Arellano authored Apr 22, 2024
1 parent fca45c4 commit 75e9342
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions tutorials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,28 @@ tutorials](https://github.com/Qiskit/documentation/actions/workflows/deploy-tuto
workflow. This will push the notebooks on the main branch to the environment
you select.

> [!NOTE]
> One potential gotcha is that the learning platform ignores the top-level
> heading of the notebook. These headings are only included in the notebook for
> writers' convenience. If you want to change the title of a notebook, find the
> page on https://learning-api.quantum.ibm.com/admin and change its title
> there. Make sure to update the title in the notebook too.
You should always start with deploying to "Learning platform (staging)". This
will deploy to https://learning.www-dev.quantum.ibm.com/catalog/tutorials.
Check that your tutorial renders properly.

Once you are happy with staging, rerun the [Deploy
tutorials](https://github.com/Qiskit/documentation/actions/workflows/deploy-tutorials.yml)
workflow, but this time choose "Learning platform (production)". Warning: this will
update every non-network tutorial to use the version from the `main` branch. That means
that if another author had a tutorial that was merged to `main` but not yet ready to go live
to production, you might accidentally deploy their tutorial. So, before deploying to
production, check with the team that it is okay to deploy.

After deploying to production, check https://learning.quantum.ibm.com/catalog/tutorials
to ensure your tutorial is working correctly.

## Gotcha: tutorial headings ignored

One potential gotcha is that the learning platform ignores the top-level
heading of the notebook. These headings are only included in the notebook for
writers' convenience. If you want to change the title of a notebook, find the
page on https://learning-api.quantum.ibm.com/admin and change its title
there. Make sure to update the title in the notebook too.

## Adding new tutorials

Expand Down

0 comments on commit 75e9342

Please sign in to comment.