docs, server: fix link in logformats.md #65025
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
|
This change is |
Release note: None
knz
approved these changes
May 12, 2021
There was a problem hiding this comment.
Generally, you can ensure that the files get re-generated correctly by entering the command make buildshort. Besides building cockroachdb, this also re-generates all the automatic documentation.
Separately from this, heads up that the crdb repository also has expectations about the structure of commits and in particular commit messages. Just "fix some links" doesn't quite cut it. I have updated your PR with an example for future reference.
Reviewed 3 of 3 files at r1, 2 of 2 files at r2.
Reviewable status:complete! 0 of 0 LGTMs obtained (waiting on @taroface)
|
bors r+ |
|
Build succeeded: |
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.
Fixed incorrect links in the generated logformats.md that were causing a build error on cockroachdb/docs#10273
@knz I wasn't able to correctly generate logformats.md with the changes I made to the code. The command
docgen logformats docs/generated/logformats.mdwas causing logformats.md to revert to an even earlier version of that doc, and I don't know why. I manually updated logformats.md with the correct URL and have included that file in this PR; not sure if this will work. I apologize if this creates more housekeeping work.