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

Document how to deploy tutorials #1450

Merged
merged 1 commit into from
May 29, 2024
Merged

Document how to deploy tutorials #1450

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
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,6 +430,22 @@ The add the following to your `.gitconfig` (usually found at `~/.gitconfig`).
textconv = sh -c 'sphobjinv convert plain "$0" -'
```

# How to deploy docs

## Deploy guides & API docs

This content lives on https://docs.quantum.ibm.com.

See https://github.ibm.com/IBM-Q-Software/iqp-channel-docs#syncing-content-with-open-source-repo.

### Deploy tutorials

This content lives on https://learning.quantum.ibm.com.

To deploy a file from the `tutorials/` directory in this repository, see the instructions in the [tutorials directory README](https://github.com/Qiskit/documentation/blob/main/tutorials/README.md).

To deploy a file from the ibm-quantum-learning-enablement repository, see the instructions in that repo's [tutorials directory README](https://github.ibm.com/IBM-Q-Software/ibm-quantum-learning-enablement/blob/main/tutorials/README.md).

# How to write the documentation

Refer to our [style guide](./style-guide.md) for technical writing guidance.
Expand Down
Loading