Repository navigation
[Content] Show review-stage draft wording in PR previews - #148
Merged
Merged
Conversation
The draft strip and print band always said the document is pending RMC Director approval. That is true for a draft published to the main site, but PR previews show drafts still in peer, Lead Civil, and technical review, where the message misleads reviewers. Preview builds now read "Draft for review. This document has not been approved for publication." while the main site keeps the Director wording.
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 branch was successfully deployed
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 draft strip and the printed-page draft band always read "This document is pending final approval by the RMC Director." That is accurate for a draft published to the main site, which is waiting on the Director stage. PR previews, though, show drafts that are still in peer, Lead Civil, and technical review, so the message tells reviewers the document is past their stage.
Preview builds now show:
The main site keeps the Director wording.
docusaurus.config.jsexposes the existingDOCUSAURUS_IS_PREVIEWbuild flag ascustomFields.isPreview.src/components/DraftNotice.jschooses the strip and print-band text from that flag.This applies to every draft document on the site, not just one.
Document scope
doc_location, or-):-Related issue(s)
None.
Validation
Built the site both ways and checked a draft document (LifeSim Applications Guide). The production build shows only the Director wording; a preview build (
DOCUSAURUS_IS_PREVIEW=truewith a preview base URL) shows only the review wording, on all of that document's pages.npm run test:reviewpasses.Review notes
Code-only:
/review classify code -. This PR's own preview shows the new wording on existing drafts such as the LifeSim Applications Guide.