-
Notifications
You must be signed in to change notification settings - Fork 3
Update current release #120
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
base: latest
Are you sure you want to change the base?
Changes from all commits
90c205d
c7d9b4f
b4a72c2
f886d6d
e12398f
539f95a
c386ff5
a0e457a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| == Local Documentation Preview with Docker | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This part is just developer docs for new way of preview antora with docker |
||
|
|
||
| Easy way to locally preview documentation changes without installing repository dependencies (like Node.js or Antora) on your host machine. | ||
|
|
||
| === Prerequisites | ||
|
|
||
| * Docker Engine (or Podman). | ||
| * Docker Compose. | ||
|
|
||
| === Workflow | ||
|
|
||
| . **Start the Preview** | ||
| + | ||
| To start the build process inside a container, navigate to the root directory of the repository and run the following command: | ||
| + | ||
| [source,bash] | ||
| ---- | ||
| docker compose up | ||
| ---- | ||
| + | ||
|
|
||
| . **Check the Docs** | ||
| + | ||
| Once the build is complete and the server starts, open your browser and navigate to: | ||
| + | ||
| http://localhost:3000 | ||
|
|
||
| . **Review and Rebuild** | ||
| + | ||
| The container builds the site and serves it. To view new changes: | ||
| + | ||
| * Stop the container (press `Ctrl+C`). | ||
| * Make your changes to the source files. | ||
| * Run `docker compose up` again. | ||
| + | ||
| The container will rebuild the documentation with your new changes for preview. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| services: | ||
| trento-docs: | ||
| image: node:20-bullseye | ||
| volumes: | ||
| - .:/workspace:z | ||
| - trento-docs-node_modules:/workspace/trento-docs-site/node_modules | ||
| working_dir: /workspace/trento-docs-site | ||
| command: > | ||
| bash -lc " | ||
| npm install --no-save antora http-server && | ||
| npx antora antora-playbook.yml && | ||
| npx http-server build/trento-docs-site-public/ -c-1 -p 3000 | ||
| " | ||
| ports: | ||
| - "3000:3000" | ||
|
|
||
| volumes: | ||
| trento-docs-node_modules: |
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I do not understand this. It says the file has been deleted, but I can still see its content in the html generated by antora. For the record, this information should not be removed from the user facing documentation. It's relevant.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hey @abravosuse i moved the content inside the kubernetes install article https://github.com/trento-project/docs/pull/120/files#diff-292845aaffe1326c688cd1ac76d61a5b3d0390c89f7012df5147c2da021259e8R164 So it is still here just in another place |
This file was deleted.
Uh oh!
There was an error while loading. Please reload this page.