Deploy plugin docs to GitHub Pages #608
Merged
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
timtebeek
commented
Jul 27, 2023
|
For any next such deployment, you'll want set the GitHub Pages source to GitHub Actions. Next in environments, remove the branch protections for deployment to GitHub Pages, or at least while testing on a pull request; after a merge we only deploy from tags. |
mike-solomon
approved these changes
Jul 27, 2023
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.
What's changed?
Deploy plugin docs to GitHub Pages at
https://openrewrite.github.io/rewrite-maven-plugin/plugin-info.html
What's your motivation?
We want to link to the generated docs, such that they are always up to date.
Anything in particular you'd like reviewers to focus on?
Would we want to swap for a different style?
Would we want to limit produced pages through a site.xml?
Any additional context
Intended to mostly replace: https://docs.openrewrite.org/reference/rewrite-maven-plugin
https://github.com/openrewrite/rewrite-docs/blob/master/reference/rewrite-maven-plugin.md