Omit files in 'code-examples' directory from orphan diagnostic check#667
Closed
dacharyc wants to merge 1 commit into
Closed
Omit files in 'code-examples' directory from orphan diagnostic check#667dacharyc wants to merge 1 commit into
dacharyc wants to merge 1 commit into
Conversation
Contributor
Author
|
After discussion with DOP, additional work is needed to avoid processing |
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
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.
Ticket
N/A
Notes
As part of a code example testing initiative, I am programmatically removing all hard-coded code-block directives in monorepo content. I've written tooling that moves code examples out into files with extensions that vary based on the programming language. Where the programming language is omitted, or the language is
text, the content of the code-block is written to a.txtfile. See an example in my test repo here (the dir name has changed fromuntested-examplestocode-examplessince creating this test PR): dacharyc/workflow-testing#3I'm starting to migrate docs in the monorepo using my tooling, and it's triggering a bunch of build warnings related to orphaned pages - i.e.:
WARNING(code-examples/includes/fact-connection-strings/1.txt:0ish): Page not included in any toctree and not marked :orphan:As it is valid to have
.txtfiles that are code examples used in literalincludes, I'd like to omit the orphan diagnostic when the filepath includes thecode-examplesdirectory. This should ensure we're only applying the orphan diagnostic to docs pages.If there's another way you'd prefer to handle this, I'm happy to do something different - just wanted to make it easy with a quickie PR!
README updates