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.

Sign up for GitHub

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

Describe staging vs prod for tutorials deploys #1220

Merged
merged 1 commit into from
Apr 22, 2024
Merged

Describe staging vs prod for tutorials deploys #1220

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions tutorials/README.md
View file
Open in desktop
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
Loading