Local Documentation Preview with Docker #114
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
EMaksy
commented
Nov 18, 2025
| trento-docs: | ||
| image: node:20-bullseye | ||
| volumes: | ||
| - .:/workspace:z |
Member
Author
There was a problem hiding this comment.
Added :z for selinux enforcing issues
dmpop
reviewed
Nov 18, 2025
|
|
||
| . **Start the Preview** | ||
| + | ||
| Navigate to the root directory of the repository and run the following command. This starts the build process inside a container: |
Collaborator
There was a problem hiding this comment.
Suggested change
| Navigate to the root directory of the repository and run the following command. This starts the build process inside a container: | |
| To start the build process inside a container, navigate to the root directory of the repository and run the following command: |
dmpop
approved these changes
Nov 18, 2025
abravosuse
approved these changes
Nov 18, 2025
Collaborator
abravosuse
left a comment
abravosuse
left a comment
There was a problem hiding this comment.
Based on what I see in the video, it LGTM!
gagandeepb
approved these changes
Nov 19, 2025
jagabomb
approved these changes
Nov 19, 2025
Contributor
jagabomb
left a comment
jagabomb
left a comment
There was a problem hiding this comment.
Nice! This works for better for me on a mac. 😄
EMaksy
added a commit
that referenced
this pull request
Nov 28, 2025
* Add local docs build * Fix selinux permission * Add workflow guide
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pr helps contributors quickly to preview their new changes to the antora page without setting up antora dependencies on your host.
If you have podman/docker installed just run docker-compose up and it will build the the documentation page for your selected branch
I think this is easier then having to install dependencies every time on a new host, like in this guide
https://www.trento-project.io/docs/developer/trento-docs-site/README.html#_1_clone_the_repository
Demo
Screencast.From.2025-11-18.16-09-03.mp4