Docfx check #1
Closed
Docfx check #1
Conversation
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
… in Records For Prometheus (open-telemetry#298)
kxyr
changed the title
kxyr
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
9 participants
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 adds DocFX sanity check, to see whether the build for the links for all the markdown (**.md) files in the repository are valid or not.
The log file, docfx.log, generated after running the docfx.cmd file shows there are invalid file links.
Instructions to replicate results:
docfx build docfx.json > docfx.login Terminal in the root directory will generate an error message showing a comprehensive list of broken links/missing files.Refer to https://dotnet.github.io/docfx/tutorial/docfx.exe_user_manual.html for future DocFX additions/modifications.