Repository navigation
Post preview links as part of build [DOC-792] - #54
Merged
Merged
Conversation
✅ Deploy Preview for hazelcast-documentation ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
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.
It can be annoying to navigate to the changed pages in a PR's deploy preview to confirm they look alright. This PR adds a plugin that helps with this: it posts a comment in the PR with direct links to the changed pages, grouped by docs section and version.
The plugin runs during Netlify preview build. Each link shows the page title as well as the URL slug.
I've capped the main list at 8 links per section, with an additional 12 links each in a details dropdown. For more than 20 links it lists them and then says "plus X more, too many to list".
The comment won't appear if there's no deploy preview, or if no docs pages are changed.
If you update the PR, the comment will be updated to link to the current changed pages. If you remove all the changed pages, it'll be deleted.
Example comment: