Add branch attribute to resolve doc paths #535
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
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.
At some point, someone on the doc team added a branch attribute to the shared attributes file, but didn't realize that the versioned plugin reference does not set the branch attribute (because it's not tied to a specific release). This meant that links were not resolving correctly.
This PR sets the branch to
currentso all links will point to the current version of the docs.This approach (pointing to
currentfor everything) makes the linking in the versioned plugin reference a bit fragile. As links break (because we move stuff around or features go away), we'll need to fix them in the docs.@jsvd Another option is to set the branch attribute individually in each generated plugin doc file to override the branch setting (the link would point to the version of the Logstash reference that was available when that version of the plugin was released). We don't have a huge number of links, so maybe fixing them manually is acceptable for now, but over time, this issue needs to be addressed.