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 the component template docs preview command #408

Merged
merged 1 commit into from
Feb 7, 2022

Conversation

simu
Copy link
Member

@simu simu commented Feb 7, 2022

This PR:

  • Bumps Antora preview command docker image to vshn/antora-preview:3.0.0.1. This gives us a Antora preview which auto-refreshes the docs while the command is running and updates the image to one which contains the current VSHN Kroki instance URL.
  • Only mounts <component-dir>/docs and <component-dir>/.git into the Docker container. This should avoid issues with Antora getting confused about paths in vendor not being readable in the container.
  • Exposes port 35729 of the Docker container for the auto-reload browser plugin.

See also projectsyn/modulesync-control#59

Checklist

  • Keep pull requests small so they can be easily reviewed.
  • Categorize the PR by setting a good title and adding one of the labels:
    bug, enhancement, documentation, change, breaking, dependency
    as they show up in the changelog
  • Link this PR to related issues.

@simu simu added the enhancement New feature or request label Feb 7, 2022
@simu simu force-pushed the feat/update-component-template-make-docs-serve branch from 7db7ca8 to 5bd4885 Compare February 7, 2022 13:25
@simu simu requested a review from bastjan February 7, 2022 13:26
This commit:
* Bumps Antora preview command docker image to vshn/antora-preview:3.0.0.1.
  This gives us a Antora preview which auto-refreshes the docs while the
  command is running and updates the image to one which contains the
  current VSHN Kroki instance URL.
* Only mounts `<component-dir>/docs` and `<component-dir>/.git` into the
  Docker container. This should avoid issues with Antora getting confused
  about paths in `vendor` not being readable in the container.
* Exposes port 35729 of the Docker container for the auto-reload browser
  plugin.

See also projectsyn/modulesync-control#59
@simu simu force-pushed the feat/update-component-template-make-docs-serve branch from 5bd4885 to a04cfb9 Compare February 7, 2022 13:45
@simu simu changed the title Adjust the component template docs preview command Update the component template docs preview command Feb 7, 2022
@simu simu merged commit 9ee9cb0 into master Feb 7, 2022
@simu simu deleted the feat/update-component-template-make-docs-serve branch February 7, 2022 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants