Skip to content

Commit 36741c1

Browse files
Document how to pull in new versions of preview (Qiskit#944)
It's confusing when `./start` diverges from `docs.quantum.ibm.com`. We now warn every time when running `./start`: ``` ❯ ./start Warning: this may be using an outdated version of the app. Run `docker pull qiskit/documentation` to check for updates. WARNING: The requested image's platform (linux/amd64) does not match the detected host platform (linux/arm64/v8) and no specific platform was requested ▲ Next.js 14.0.1 - Local: http://f9e8103d2cee:3000 - Network: http://172.17.0.2:3000 ✓ Ready in 1377ms [remoteRefresh] server is listening at port 5001 ``` I debated always running `docker pull qiskit/documentation` automatically, but I think it's too slow and annoying.
1 parent 27f8821 commit 36741c1

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,8 @@ API name.
9292

9393
For translations, put the language code in front of the URL, like http://localhost:3000/es/start or http://localhost:3000/fr/start. You can find the language codes by looking in the `translations/` folder.
9494

95+
Warning: `./start` does not check if there is a new version of the docs application available. Run `docker pull qiskit/documentation` to update to the latest version of the app.
96+
9597
## Preview the docs in PRs
9698

9799
Contributors with write access to this repository can use live previews of the docs: GitHub will deploy a website using your changes.

start

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
# that they have been altered from the originals.
1313

1414
import subprocess
15+
import sys
1516
from pathlib import Path
1617
from typing import Iterator
1718

@@ -30,6 +31,11 @@ def translation_volume_mounts() -> Iterator[str]:
3031

3132

3233
def main() -> None:
34+
print(
35+
"Warning: this may be using an outdated version of the app. Run "
36+
+ "`docker pull qiskit/documentation` to check for updates.",
37+
file=sys.stderr,
38+
)
3339
subprocess.run(
3440
# Keep this aligned with the Dockerfile at the root of the repository.
3541
[

0 commit comments

Comments
 (0)