Fix broken Edit links #3321
Merged
Fix broken Edit links #3321
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
monicasarbu
approved these changes
Jan 10, 2017
| include::./packetbeat-geoip.asciidoc[] | ||
|
|
||
| pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/shared-logstash-config.asciidoc ?>] |
There was a problem hiding this comment.
I think here it should point to: https://github.com/elastic/beats/edit/master/packetbeat/docs/shared-logstash-config.asciidoc
There was a problem hiding this comment.
Sorry, it looks like your link is working: https://github.com/elastic/beats/edit/master/libbeat/docs/shared-logstash-config.asciidoc
This was referenced Jan 11, 2017
Merged
tsg
pushed a commit
that referenced
this pull request
Jan 12, 2017
…3312, #3331, #3336) (#3345) * Edit haproxy module docs * Add fixes from review feedback * Fix broken Edit links * Clarify when registry file is updated in docs (#3274) See #3220 (comment) * Update close_timeout docs (#3320) Clarified close_timeout when there are updates to the file. * Fix typo in regexp Should be `regexp` and not `reqexp` * Fix a couple of typos and a broken link * Change "versions" to "supported_protocols" (#3336) Urso pointed out during the Heartbeat review that this name is wrong.
tsg
pushed a commit
that referenced
this pull request
Jan 12, 2017
…3331, #3336) (#3347) * Edit haproxy module docs * Add fixes from review feedback * Fix broken Edit links * Update close_timeout docs (#3320) Clarified close_timeout when there are updates to the file. * Fix typo in regexp Should be `regexp` and not `reqexp` * Fix a couple of typos and a broken link * Change "versions" to "supported_protocols" (#3336) Urso pointed out during the Heartbeat review that this name is wrong.
leweafan
pushed a commit
to leweafan/beats
that referenced
this pull request
Apr 28, 2023
…lastic#3320, elastic#3312, elastic#3331, elastic#3336) (elastic#3347) * Edit haproxy module docs * Add fixes from review feedback * Fix broken Edit links * Update close_timeout docs (elastic#3320) Clarified close_timeout when there are updates to the file. * Fix typo in regexp Should be `regexp` and not `reqexp` * Fix a couple of typos and a broken link * Change "versions" to "supported_protocols" (elastic#3336) Urso pointed out during the Heartbeat review that this name is wrong.
leweafan
pushed a commit
to leweafan/beats
that referenced
this pull request
Apr 28, 2023
…lastic#3274, elastic#3320, elastic#3312, elastic#3331, elastic#3336) (elastic#3345) * Edit haproxy module docs * Add fixes from review feedback * Fix broken Edit links * Clarify when registry file is updated in docs (elastic#3274) See elastic#3220 (comment) * Update close_timeout docs (elastic#3320) Clarified close_timeout when there are updates to the file. * Fix typo in regexp Should be `regexp` and not `reqexp` * Fix a couple of typos and a broken link * Change "versions" to "supported_protocols" (elastic#3336) Urso pointed out during the Heartbeat review that this name is wrong.
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.
This PR fixes the broken Edit links that pointed to shared (single-sourced) content in libbeat.
Because the macro that we use to set the Edit url doesn't accept variables in the path (couldn't use
{doc-branch}), I decided to point edits tomasterrather than a specific branch name. This in keeping with our preference for having PRs submitted to themasterbranch and then back/forward ported. It's also consistent with how Logstash handles doc edits.All the Edit links in the book will now point to the
masterbranch. The one main drawback of this approach is that the user might see a problem that exists in the current doc, but has been fixed inmaster. Also, the content inmasterwon't always match what the user sees in the published doc (especially as the doc ages), and it's possible that the link will no longer work if we delete the file inmaster.It's the best solution we have for now, though, unless we want to update all the URL paths in all these links whenever we cut a new branch.
NOTE: You'll probably notice that there area couple of instances where I set the Edit url to the location of the shared logstash config doc even though there is a corresponding local file. The local file is just a heading that wraps the shared content, so I figured it was better just to point users to the shared content.