add deploy preview workflow #10324
Open
add deploy preview workflow #10324
Conversation
This file contains 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
|
|
jdbaldry
approved these changes
Dec 30, 2024
|
❤️ 🥳 🎆 |
Comment on lines
+22
to
+23
| website_directory: content/docs/mimir/latest | ||
| relative_prefix: /docs/mimir/latest/ |
There was a problem hiding this comment.
this repo also hosts the mimir-distributed helm chart docs under https://github.com/grafana/mimir/tree/3050e72641187ecaf84792036d23843d37f8cbce/docs/sources/helm-charts/mimir-distributed
does this config prevent from rendering those docs too?
There was a problem hiding this comment.
Well remembered, I think we'll need to modify and release a v2 of the workflow that supports multiple source directories.
There was a problem hiding this comment.
In the mean time
Suggested change
| website_directory: content/docs/mimir/latest | |
| relative_prefix: /docs/mimir/latest/ | |
| source_directory: docs/sources/mimir | |
| website_directory: content/docs/mimir/latest | |
| relative_prefix: /docs/mimir/latest/ |
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.
for https://github.com/grafana/website/issues/10101
What is this feature?
This PR adds a workflow to deploy the output of the
make docscommand to a public deploy preview. The workflow posts a comment with a link to the preview after it has been deployed.Why do we need this feature?
Docs contributors will no longer need to run
make docson their machine, as they will be able to view the deploy preview instead.Who is this feature for?
Everyone.