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

Update README.md to point to tutorials deployment instructions #1403

Closed
wants to merge 10 commits into from
32 changes: 25 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Qiskit docs

The documentation content home for https://docs.quantum.ibm.com (excluding API reference).
The documentation content home for [https://docs.quantum.ibm.com](https://docs.quantum.ibm.com) (excluding API reference).
abbycross marked this conversation as resolved.
Show resolved Hide resolved

# Improving IBM Quantum & Qiskit Documentation

Expand Down Expand Up @@ -76,7 +76,7 @@ npm install
You can preview the docs locally by following these two steps:

1. Ensure Docker is running. For example, open Rancher Desktop.
2. Run `./start` in your terminal, and open http://localhost:3000 in your browser.
2. Run `./start` in your terminal, and open `http://localhost:3000` in your browser.
abbycross marked this conversation as resolved.
Show resolved Hide resolved

The preview application does not include the top nav bar. Instead, navigate to the folder you want with the links in the home page. You can return to the home page at any time by clicking "IBM Quantum Documentation Preview" in the top-left of the header.

Expand All @@ -97,7 +97,7 @@ To use live previews, push your branch to `upstream` rather than your fork. GitH

## Staging

We also re-deploy the docs every time we merge into `main` at the site https://qiskit-docs-preview-staging.1799mxdls7qz.us-south.codeengine.appdomain.cloud.
We also re-deploy the docs every time we merge into `main` at the site `https://qiskit-docs-preview-staging.1799mxdls7qz.us-south.codeengine.appdomain.cloud`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto, why? It's useful to click the link


This staging environment can be useful to see how the docs are rendering before we push it live to production.

Expand All @@ -122,14 +122,19 @@ you can run `apt-get install texlive-pictures texlive-latex-extra poppler-utils
graphviz`.

- To execute all notebooks, run tox.

```sh
tox
```

- To only execute specific notebooks, pass them as arguments.

```sh
tox -- path/to/notebook.ipynb path/to/another-notbook.ipynb
```

- To write the execution results to the file, pass the `--write` argument.

```sh
tox -- optional/paths/to/notebooks.ipynb --write
```
Expand Down Expand Up @@ -380,7 +385,7 @@ In this case, no commit will be automatically created.
This is useful when new docs content is published, usually corresponding to new releases or hotfixes for content issues. If you're generating a patch release, also see the below subsection for additional steps.

1. Choose which documentation you want to generate (`qiskit`, `qiskit-ibm-provider`, `qiskit-ibm-runtime`, or `qiskit-transpiler-service`) and its version.
2. Determine the full version, such as by looking at https://github.com/Qiskit/qiskit/releases
2. Determine the full version, such as by looking at <https://github.com/Qiskit/qiskit/releases>
abbycross marked this conversation as resolved.
Show resolved Hide resolved
3. Download a CI artifact with the project's documentation. To find this:
1. Pull up the CI runs for the stable commit that you want to build docs from. This should not be from a Pull Request
2. Open up the "Details" for the relevant workflow.
Expand All @@ -391,7 +396,7 @@ This is useful when new docs content is published, usually corresponding to new
4. Scroll down to "Artifacts" and look for the artifact related to documentation, such as `html_docs`.
5. Download the artifact by clicking on its name.
4. Rename the downloaded zip file with its version number, e.g. `0.45.zip` for an artifact from `qiskit v0.45.2`.
5. Upload the renamed zip file to https://ibm.ent.box.com/folder/246867452622
5. Upload the renamed zip file to <https://ibm.ent.box.com/folder/246867452622>
6. Share the file by clicking the `Copy shared link` button
7. Select `People with the link` and go to `Link Settings`.
8. Under `Link Expiration` select `Disable Shared Link on` and set an expiration date of ~10 years into the future.
Expand Down Expand Up @@ -430,6 +435,18 @@ The add the following to your `.gitconfig` (usually found at `~/.gitconfig`).
textconv = sh -c 'sphobjinv convert plain "$0" -'
```

## How to deploy docs

### Docs (content that lives on IBM Quantum Platform)
abbycross marked this conversation as resolved.
Show resolved Hide resolved

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

### Tutorials (content that lives on the Learning Platform

If you need to deploy a file from the `/tutorials/` directory to the Learning Platform, see the instructions in the [tutorials directory README](https://github.com/Qiskit/documentation/blob/main/tutorials/README.md).

If you are deploying a file from the learning-enablement-sme repo to the Learning Platform, 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 Expand Up @@ -502,11 +519,11 @@ $$

## Tables

Tables are supported: https://www.markdownguide.org/extended-syntax/.
Tables are supported: <https://www.markdownguide.org/extended-syntax/>.

## Comments

Example comment: {/_ Comes from https://qiskit.org/documentation/partners/qiskit_ibm_runtime/getting_started.html _/}
Example comment: {/_Comes from <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/getting_started.html>_/}

## Collapsible sections

Expand Down Expand Up @@ -685,6 +702,7 @@ Some companies require a special attribution notice. View a list of the companie
- IBM&reg;
- IBM Cloud&reg;
- IBM Quantum&trade;

</details>

**Note**: Although Qiskit is a registered trademark of IBM, we do not mark it as such.
Expand Down
Loading