You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add local docs preview for IBM contributors (Qiskit#54)
ClosesQiskit#1. Running `./start` will
open up the One Docs app at localhost:3000 using content from the local
repository.
Currently, you have to log into IBM Cloud and have the correct
permissions. We will improve this with
Qiskit#53.
---------
Co-authored-by: Axel Hernández Ferrera <axelhzf@gmail.com>
Co-authored-by: Luciano Bello <bel@zurich.ibm.com>
Copy file name to clipboardExpand all lines: README.md
+17-2Lines changed: 17 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -8,16 +8,31 @@ The documentation content home for https://docs.quantum-computing.ibm.com. Refer
8
8
9
9
These tools will also run in CI. But, it can be convenient when iterating to run the tools locally.
10
10
11
-
First, install the below:
11
+
Currently, this workflow only works for IBM maintainers. We are prioritizing fixing this workflow so that anyone can run the tools locally, tracked by https://github.com/Qiskit/docs/issues/53.
12
+
13
+
First, install the below software:
12
14
13
15
1.[Node.js](https://nodejs.org/en). If you expect to use JavaScript in other projects, consider using [NVM](https://github.com/nvm-sh/nvm). Otherwise, consider using [Homebrew](https://formulae.brew.sh/formula/node) or installing [Node.js directly](https://nodejs.org/en).
3.[Docker](https://www.docker.com). You must also ensure that it is running.
18
+
* You can use [Colima](https://github.com/abiosoft/colima) or [Rancher Desktop](https://rancherdesktop.io). When installing Rancher Desktop, choose Moby/Dockerd as the engine, rather than nerdctl. To ensure it's running, open up the app "Rancher Desktop".
19
+
20
+
Set up IBM Cloud to access the Docker image:
21
+
22
+
1.`ibmcloud plugin install cr`
23
+
2.`ibmcloud cr region-set global`
24
+
3. Make sure Docker is running, then `ibmcloud cr login`
14
25
15
-
Then, install the dependencies with:
26
+
Finally, install the dependencies with:
16
27
17
28
```bash
18
29
npm install
19
30
```
20
31
32
+
## Preview the docs locally
33
+
34
+
Run `./start` in your terminal, then open http://localhost:3000 in your browser.
35
+
21
36
## Spellcheck
22
37
23
38
We use [cSpell](https://cspell.org) to check for spelling. The `lint` job in CI will fail if there are spelling issues.
0 commit comments