Repository navigation
[Content] Keep underscore-prefixed doc files out of the built site - #149
Merged
Merged
Conversation
Setting the docs plugin's exclude option replaces Docusaurus's default exclude list, so underscore-prefixed partials and authoring notes such as _input-needed.md were being built as public pages. Restore the default patterns ahead of the inactive-document excludes.
Collaborator
Author
|
/review classify code - |
Review workflowPurpose: content · Classification: code
Next: Administrator: inspect and merge after CI passes Completed stages persist until an administrator restarts them. Replies and resolved threads are not approval requirements. Use This PR has merged. Production deployment follows the main approval process. |
usace-rmc-docs-review
Bot
changed the title
usace-rmc-docs-review
Bot
added
purpose:content
stage:ready-to-merge
|
@USACE-RMC/docs-admin — review requirements are satisfied. Inspect the changes, fill document attribution manually, and merge when CI passes. |
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.
Description
The docs plugin's
excludeoption indocusaurus.config.jsis set to the inactive-document list. Settingexcludereplaces Docusaurus's default exclude list instead of adding to it, so the default rule that keeps underscore-prefixed files out of the build no longer applied.As a result, authoring files such as
_input-needed.md(the open-questions questionnaire that travels with a document draft) were being built as public pages. The PR preview for #146 currently serves the BEP questionnaire at.../v1.0/_input-needed/.This restores Docusaurus's default patterns (
**/_*.{js,jsx,ts,tsx,md,mdx},**/_*/**,**/*.test.{js,jsx,ts,tsx},**/__tests__/**) ahead of the inactive-document excludes.Document scope
doc_location, or-):-Related issue(s)
None.
Validation
DOCS_MODE=prod npm run buildpasses. With this config applied on the BEP document branch, the build no longer emits an_input-neededpage, and every document chapter still builds. No tracked file onmainstarts with an underscore, so nothing currently published is removed.Review notes
Code-only:
/review classify code -. After it merges,mainwill be merged into #145 and #146 so their previews stop publishing the questionnaires.