Migrate WAF to UDR #450

im2nguyen · 2025-05-29T08:06:15Z

This is an experimental branch to migrate WAF (Well Architected Framework) content into UDR. In addition, it converts the WAF content layout from "tutorials" to "docs", a long-standing request by CJ.

This requires changes to the dev-portal repo too.

🔍 Preview

github-actions · 2025-05-29T08:06:59Z

Vercel Previews Deployed

Name	Status	Preview	Updated (UTC)
Dev Portal	✅ Ready (Inspect)	Visit Preview	Thu Aug 7 20:24:45 UTC 2025
Unified Docs API	✅ Ready (Inspect)	Visit Preview	Thu Aug 7 20:14:18 UTC 2025

RubenSandwich · 2025-06-02T16:39:08Z

docker-compose.yaml

@@ -3,7 +3,7 @@

 services:
  dev-portal:
-    image: 'hashicorp/dev-portal:latest'
+    image: 'dev-portal:waf-docs'


@im2nguyen what is the difference between these two images of dev-portal?

It's updating it from tutorials to docs: hashicorp/dev-portal#2763

…ne-processes/create-high-performing-teams/collaboration.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>

Merge create high performing teams into WAF branch https://hashicorp.atlassian.net/jira/software/c/projects/WAF/boards/2173?assignee=63690774d60bd2b365f85ffa&assignee=627a65e0f29dcb0068f86381&selectedIssue=WAF-316

judithpatudith

I think this goes through the end of automate! Submitting it now so you have it Monday!

...ocs/define-and-automate-processes/build-culture/create-high-performing-teams/recognition.mdx

content/well-architected-framework/data/docs-nav-data.json

content/well-architected-framework/docs/docs/define-and-automate-processes/define/workflows.mdx

judithpatudith · 2025-08-01T23:22:59Z

...hitected-framework/docs/docs/define-and-automate-processes/define/as-code/infrastructure.mdx

+
+# Define your infrastructure systems
+
+Before you can automate your infrastructure processes, you need to clearly define what infrastructure systems and tools you need. Using infrastructure as code (IaC) to define your systems creates a clear, version-controlled specification of your infrastructure that can be reviewed, tested, and automated.


I'm not sure this paragraph makes any sense. IaC is how you codify your infrastructure, but here we're saying that before we codify it we should define it, and we should define it by codifying it.

"automate your infrastructure" -> using hcp terraform <> gitops to deploy your terraform config when you change it (fully automated workflow)

"defining your infrastructure" -> taking what you have and turning into terraform (semi-automated workflow)

...hitected-framework/docs/docs/define-and-automate-processes/define/as-code/infrastructure.mdx

...ll-architected-framework/docs/docs/define-and-automate-processes/define/as-code/database.mdx

...ll-architected-framework/docs/docs/define-and-automate-processes/define/as-code/security.mdx

...-architected-framework/docs/docs/define-and-automate-processes/define/as-code/monitoring.mdx

...ted-framework/docs/docs/define-and-automate-processes/process-automation/fully-automated.mdx

…te-processes/process-automation/index.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>

…te-processes/process-automation/fully-automated.mdx

…te-processes/define/workflows.mdx Co-authored-by: Judith Malnick <judith@hashicorp.com>

…te-processes/define/as-code/monitoring.mdx Co-authored-by: Judith Malnick <judith@hashicorp.com>

…te-processes/define/as-code/database.mdx Co-authored-by: Judith Malnick <judith@hashicorp.com>

…-docs into migrate-waf-to-udr

Co-authored-by: Judith Malnick <judith@hashicorp.com>

…-docs into migrate-waf-to-udr

roooms · 2025-08-06T11:52:43Z

I've had a read through of the structure and hierarchy of this content but haven't had the time to read every one of the 99 mdx files included in this change. Overall I think the section and page headings are great and a much better approach than following other examples of a WAF. This feels much more HashiCorp.

Couple of points that need addressing:

I found quite a few broken links when topics link to further reading. I think most of these were when jumping between WAF and docs, so maybe that will resolve itself once everything merges, but it should be checked.
I don't think the implementation resources section fits in the WAF and could be a good breakpoint to provide more guidance to Ent customers in an agreed format.
I still find it awkward that we're addressing both CE and Ent in the same space and providing scale guidance for CE. Is the goal of this content to make readers successful at scale with our CE tools? Is there any expectation or recommendation that they need to move to Ent to scale? Our CE tools are one of the biggest competitors for successful commercial customer acquisition.

cjobermaier · 2025-08-06T16:39:55Z

Before merge we need to remove the sleep from the GHA

Add sleep so dev-portal finishes after dev portal preview. This makes sure the new WAF preview builds.

github-actions · 2025-08-06T20:36:09Z

Broken Link Checker

Summary

Status	Count
🔍 Total	871
✅ Successful	849
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	21
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in content/well-architected-framework/docs/docs/secure-systems/validate-software-integrity.mdx

[403] https://www.darkreading.com/application-security/supply-chain-attacks-github-actions-gravity-forms-npm | Network error: Forbidden
Full Github Actions output

cjobermaier · 2025-08-06T21:32:38Z

.github/workflows/build-pr-preview.yml

          command: |
            cd unified-docs-frontend-preview
+            sleep 300


Remove before merge.

Migrate WAF to UDR

aa549e5

im2nguyen requested a review from a team as a code owner May 29, 2025 08:06

im2nguyen added the do not merge label May 29, 2025

im2nguyen requested a review from LeahMarieBush May 29, 2025 08:06

im2nguyen mentioned this pull request May 29, 2025

Switch WAF to use docs layout instead of tutorials, migrate to UDR hashicorp/dev-portal#2763

Merged

im2nguyen and others added 3 commits May 29, 2025 01:47

add index file for waf so itll load the index page

e1ec28b

mock up for waf content

f83767a

Merge branch 'main' into migrate-waf-to-udr

e0ac5c8

RubenSandwich reviewed Jun 2, 2025

View reviewed changes

cjobermaier and others added 20 commits June 9, 2025 09:46

add appendix example

7be8eb5

Merge branch 'main' into migrate-waf-to-udr

0535bbb

ready for content to be pushed

cce6a7e

Update docs-nav-data.json

72df44f

Add files via upload

a27f2fe

Update content/well-architected-framework/docs/docs/automate-and-defi…

8a2fe15

…ne-processes/create-high-performing-teams/collaboration.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>

Update content/well-architected-framework/docs/docs/automate-and-defi…

2f18211

…ne-processes/create-high-performing-teams/collaboration.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>

Update overview.mdx

051a36e

Update collaboration.mdx

14e97b3

Waf 316 create high performing teams (#559)

2b5daa1

Merge create high performing teams into WAF branch https://hashicorp.atlassian.net/jira/software/c/projects/WAF/boards/2173?assignee=63690774d60bd2b365f85ffa&assignee=627a65e0f29dcb0068f86381&selectedIssue=WAF-316

first push to build preview

95c9460

WAF 315 zero downtime deployments (#575)

d1b7513

first commit to build preview

a5d1489

rough draft of docs

8edde35

change to team and culture

32686b1

move policy as code up one

bd1b115

WAF-306 test

c4b4cdf

moved policy as code to comp and gov

0c0ff97

ready for review

18e4eb9

push first pass

323d8ff

judithpatudith reviewed Aug 2, 2025

View reviewed changes

cjobermaier reviewed Aug 4, 2025

View reviewed changes

...ted-framework/docs/docs/define-and-automate-processes/process-automation/fully-automated.mdx Outdated Show resolved Hide resolved

cjobermaier and others added 13 commits August 4, 2025 09:27

Update content/well-architected-framework/docs/docs/define-and-automa…

4c2fcf1

…te-processes/process-automation/index.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>

Update content/well-architected-framework/docs/docs/define-and-automa…

9ecbd3e

…te-processes/process-automation/fully-automated.mdx

fix codify systems for index

3d71303

Update content/well-architected-framework/docs/docs/define-and-automa…

4132fb3

…te-processes/define/workflows.mdx Co-authored-by: Judith Malnick <judith@hashicorp.com>

Update content/well-architected-framework/docs/docs/define-and-automa…

9331d98

…te-processes/define/as-code/monitoring.mdx Co-authored-by: Judith Malnick <judith@hashicorp.com>

Update content/well-architected-framework/docs/docs/define-and-automa…

2d0cd6f

…te-processes/define/as-code/database.mdx Co-authored-by: Judith Malnick <judith@hashicorp.com>

fix index

2cfb50e

Merge branch 'migrate-waf-to-udr' of github.com:hashicorp/web-unified…

2d3795c

…-docs into migrate-waf-to-udr

Apply suggestions from code review

47af604

Co-authored-by: Judith Malnick <judith@hashicorp.com>

re-wrote database to give three main benefits

4b752e4

Merge branch 'migrate-waf-to-udr' of github.com:hashicorp/web-unified…

0caac63

…-docs into migrate-waf-to-udr

add list

11cbc0d

Change titles to start with verb

dad61d0

cjobermaier and others added 2 commits August 6, 2025 11:43

Update build-pr-preview.yml

517f9c5

Add sleep so dev-portal finishes after dev portal preview. This makes sure the new WAF preview builds.

run new broken link build

461d835

cjobermaier added 2 commits August 6, 2025 15:44

run new broken link build

9091d7d

Merge branch 'main' into migrate-waf-to-udr

4b389f3

cjobermaier reviewed Aug 6, 2025

View reviewed changes

.github/workflows/build-pr-preview.yml

command: |

cd unified-docs-frontend-preview

sleep 300

Copy link

Contributor

cjobermaier Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove before merge.

cjobermaier added 5 commits August 6, 2025 16:45

more url fixes

cb3a4e4

more broken links

b3cab16

more link fixes

6c53b37

fix broken links

6b3bc48

fix broken links

7cd5fe6

cjobermaier merged commit 8d0a4dd into main Aug 11, 2025
14 of 16 checks passed

cjobermaier deleted the migrate-waf-to-udr branch August 11, 2025 16:04


		# Define your infrastructure systems

		Before you can automate your infrastructure processes, you need to clearly define what infrastructure systems and tools you need. Using infrastructure as code (IaC) to define your systems creates a clear, version-controlled specification of your infrastructure that can be reviewed, tested, and automated.

Migrate WAF to UDR #450

Migrate WAF to UDR #450

Uh oh!

Conversation

im2nguyen commented May 29, 2025 • edited by judithpatudith Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Vercel Previews Deployed

Uh oh!

RubenSandwich Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

im2nguyen Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

judithpatudith left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

judithpatudith Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

im2nguyen Aug 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

roooms commented Aug 6, 2025

Uh oh!

cjobermaier commented Aug 6, 2025

Uh oh!

github-actions bot commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Broken Link Checker

Summary

Errors per input

Errors in content/well-architected-framework/docs/docs/secure-systems/validate-software-integrity.mdx

Uh oh!

cjobermaier Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

im2nguyen commented May 29, 2025 •

edited by judithpatudith

Loading

github-actions bot commented May 29, 2025 •

edited

Loading

github-actions bot commented Aug 6, 2025 •

edited

Loading