Skip to content

Add draft banner to GH Pages and PR preview builds #4445

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
merged 5 commits into from
Jun 13, 2025
Merged

Add draft banner to GH Pages and PR preview builds #4445

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
de00a41
Add draft banner to GH Pages and PR preview builds
kfranqueiro Jun 12, 2025
7ac1def
Update message to Kevin's recommendation
kfranqueiro Jun 12, 2025
69b698c
Tweak link wording
kfranqueiro Jun 12, 2025
8682392
Update section markup
kfranqueiro Jun 13, 2025
b82536d
re-word "not yet approved" -> "not finalized"
kfranqueiro Jun 13, 2025
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
4 changes: 4 additions & 0 deletions 11ty/CustomLiquid.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,10 @@ export class CustomLiquid extends Liquid {
const prependedIncludes = ["header"];
const appendedIncludes = ["wai-site-footer", "site-footer"];

// Include draft banner at top of informative pages for GH Pages builds and PR previews
if (process.env.WCAG_MODE === "editors" || (process.env.COMMIT_REF && !process.env.WCAG_MODE))
prependedIncludes.unshift("draft-banner");

if (isUnderstanding)
prependedIncludes.push(
isIndex ? "understanding/navigation-index" : "understanding/navigation"
Expand Down
10 changes: 10 additions & 0 deletions _includes/draft-banner.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{%- comment -%}
Banner shown only on builds of informative docs for GitHub Pages.
{%- endcomment -%}
{%- assign pubSlug = page.url | replace: "techniques", "Techniques" | replace: "understanding", "Understanding" | replace_last: ".html", "" -%}
<section class="default-grid info" tabindex="0" lang="en">
<p class="inner">
This is an unpublished editor’s draft that might include content that is not yet approved.
<a href="https://www.w3.org/WAI/WCAG{{ version }}{{ pubSlug }}">View the published version</a>
</p>
</section>