Skip to content

[Content] Show review-stage draft wording in PR previews #148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AdamGohs merged 1 commit into from
Oct 15, 2026
Merged

[Content] Show review-stage draft wording in PR previews #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ export default {
onBrokenAnchors: 'warn',
url: process.env.DOCUSAURUS_URL || 'https://USACE-RMC.github.io',
baseUrl: process.env.DOCUSAURUS_BASE_URL || '/RMC-Software-Documentation/',
customFields: {
isPreview: process.env.DOCUSAURUS_IS_PREVIEW === 'true',
},
favicon: 'img/USACE.png',
organizationName: 'USACE-RMC', // Your GitHub organization or username
projectName: 'RMC-Software-Documentation', // Your project name, make sure this matches your GitHub repo name
Expand Down
16 changes: 13 additions & 3 deletions src/components/DraftNotice.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { useLocation } from '@docusaurus/router';
import useBaseUrl from '@docusaurus/useBaseUrl';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import latestVersions from '@site/static/versions/latestVersions.json';
import { draftDocs } from '../draftDocs';

Expand All @@ -20,6 +21,13 @@ import { draftDocs } from '../draftDocs';
*/

export const DRAFT_STATUS_TEXT = 'This document is pending final approval by the RMC Director.';
// A PR preview shows the draft while it is still in review, before the Director stage.
export const PREVIEW_DRAFT_STATUS_TEXT = 'Draft for review. This document has not been approved for publication.';

function useDraftStatusText() {
const { siteConfig } = useDocusaurusContext();
return siteConfig.customFields?.isPreview ? PREVIEW_DRAFT_STATUS_TEXT : DRAFT_STATUS_TEXT;
}

function getDocInfo(pathname, docsBase) {
// docsBase is derived from siteConfig.baseUrl, so this resolves under every
Expand Down Expand Up @@ -63,12 +71,13 @@ export function useIsDraftDoc() {
*/
export const DraftStatusStrip = () => {
const isDraft = useIsDraftDoc();
const statusText = useDraftStatusText();
if (!isDraft) return null;

return (
<div className="draft-strip-anchor">
<div className="draft-strip" role="note" aria-label="Document status">
{DRAFT_STATUS_TEXT}
{statusText}
</div>
</div>
);
Expand All @@ -84,6 +93,7 @@ export const DraftStatusStrip = () => {
*/
export const DraftPrintFrame = ({ children }) => {
const isDraft = useIsDraftDoc();
const statusText = useDraftStatusText();
if (!isDraft) return <>{children}</>;

return (
Expand All @@ -92,7 +102,7 @@ export const DraftPrintFrame = ({ children }) => {
<tr>
<td>
<div className="draft-print-frame__band" aria-hidden="true">
{DRAFT_STATUS_TEXT}
{statusText}
</div>
</td>
</tr>
Expand All @@ -106,7 +116,7 @@ export const DraftPrintFrame = ({ children }) => {
<tr>
<td>
<div className="draft-print-frame__band draft-print-frame__band--foot" aria-hidden="true">
{DRAFT_STATUS_TEXT}
{statusText}
</div>
</td>
</tr>
Expand Down
Loading