AWSO Documentation updates - #6940
Conversation
Retain the parent "Deploy and Use AWS Observability" category and split its content into two version subcategories: v3.0.0 (latest) and v2.15.0. Each contains the full doc set. Add a parent launcher landing page, repoint intra-version links, and add redirects for the moved 2.15.0 URLs. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Rename the v300/v215 subfolders to the dotted v3.0.0/v2.15.0 form and update all references: slugs, intra-version links, sidebar IDs, redirect targets, parent launcher cards, and the migration guides' links into the version docs. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Update cross-repo markdown links (release notes, API docs, FAQ, about, fedramp, control-tower) that referenced the pre-restructure paths so they resolve to the v2.15.0 version docs, fixing the production build. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
kimsauce
left a comment
kimsauce
left a comment
There was a problem hiding this comment.
Solid restructuring overall — the v2.15.0 rename, redirects, migration guides, and sidebar are all clean. But v3.0.0/index.md and v3.0.0/changelog.md look like they were scaffolded by copying the old/v2.15.0 equivalents and never updated for v3.0.0: every card on the new v3.0.0 landing page currently links into the old flat paths (which redirect to v2.15.0, not v3.0.0), and the v3.0.0 changelog is a byte-for-byte copy of the v2.15.0 one with no v3.0.0 entry. Since this is the page linked as "v3.0.0 (latest)" from the top-level index and sidebar, it's likely to be a new user's first click into the new version — flagging as request-changes so these don't ship silently. Left inline suggestions for the straightforward link fixes; a couple of others need a content decision rather than a mechanical fix. Everything else here looks ready to go.
| :::training Micro Lesson | ||
|
|
||
| Watch a micro lesson on deploying the AWS Observability Solution. | ||
|
|
There was a problem hiding this comment.
This Micro Lesson is titled "Tutorial: Setting Up AWS Observability Solution V2.4.0 Using CloudFormation Template Video" — leftover from copying the old index page. Showing a v2.4.0-specific tutorial on the v3.0.0 landing page is confusing given how much the CFN parameters changed (see the migration guide's parameter-mapping table). Worth removing or swapping for v3.0.0-specific guidance.
| <div className="box-wrapper"> | ||
| <div className="box smallbox card"> | ||
| <div className="container"> | ||
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/before-you-deploy/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>Before You Deploy</h4></a> |
There was a problem hiding this comment.
All 9 cards on this page (lines 42, 48, 54, 60, 66, 72, 78, 84, 90) link to the old flat paths instead of v3.0.0/.... Those flat paths no longer exist as real content — they now redirect to the v2.15.0 docs (see cid-redirects.json), so anyone landing on this "latest" page and clicking a card is silently sent into v2.15.0 instructions instead.
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/before-you-deploy/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>Before You Deploy</h4></a> | |
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/v3.0.0/before-you-deploy/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>Before You Deploy</h4></a> |
| </div> | ||
| <div className="box smallbox card"> | ||
| <div className="container"> | ||
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/deploy-with-aws-cloudformation/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>Deploy with AWS CloudFormation</h4></a> |
There was a problem hiding this comment.
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/deploy-with-aws-cloudformation/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>Deploy with AWS CloudFormation</h4></a> | |
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/v3.0.0/deploy-with-aws-cloudformation/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>Deploy with AWS CloudFormation</h4></a> |
| </div> | ||
| <div className="box smallbox card"> | ||
| <div className="container"> | ||
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/deploy-with-terraform/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>Deploy with Terraform</h4></a> |
There was a problem hiding this comment.
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/deploy-with-terraform/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>Deploy with Terraform</h4></a> | |
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/v3.0.0/deploy-with-terraform/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>Deploy with Terraform</h4></a> |
| </div> | ||
| <div className="box smallbox card"> | ||
| <div className="container"> | ||
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/migration-strategy-using-terraform/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>Migration Strategy from CloudWatch Source to Kinesis Firehose Source using Terraform</h4></a> |
There was a problem hiding this comment.
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/migration-strategy-using-terraform/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>Migration Strategy from CloudWatch Source to Kinesis Firehose Source using Terraform</h4></a> | |
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/v3.0.0/migration-strategy-using-terraform/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>Migration Strategy from CloudWatch Source to Kinesis Firehose Source using Terraform</h4></a> |
| </div> | ||
| <div className="box smallbox card"> | ||
| <div className="container"> | ||
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/update-aws-observability-stack/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>Update the AWS Observability Stack</h4></a> |
There was a problem hiding this comment.
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/update-aws-observability-stack/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>Update the AWS Observability Stack</h4></a> | |
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/v3.0.0/update-aws-observability-stack/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>Update the AWS Observability Stack</h4></a> |
| </div> | ||
| <div className="box smallbox card"> | ||
| <div className="container"> | ||
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/resources/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>AWS Observability Resources</h4></a> |
There was a problem hiding this comment.
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/resources/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>AWS Observability Resources</h4></a> | |
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/v3.0.0/resources/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>AWS Observability Resources</h4></a> |
| </div> | ||
| <div className="box smallbox card"> | ||
| <div className="container"> | ||
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/changelog/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>AWS Observability Terraform script and CloudFormation Changelog</h4></a> |
There was a problem hiding this comment.
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/changelog/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>AWS Observability Terraform script and CloudFormation Changelog</h4></a> | |
| <a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/v3.0.0/changelog/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>AWS Observability Terraform script and CloudFormation Changelog</h4></a> |
| @@ -0,0 +1,345 @@ | |||
| --- | |||
There was a problem hiding this comment.
This file is a verbatim copy of v2.15.0/changelog.md — the "AWSO lifecycle" table still lists 2.15.0 as the newest release, and version history runs from ## v2.15.0 down to ## v1.0.0 with no ## v3.0.0 entry anywhere. Once the index.md links above point here correctly, this page won't actually tell users anything changed in v3.0.0 (breaking parameter renames, etc. are documented in the migration guides but not here).
| @@ -1,4 +1,16 @@ | |||
| { | |||
| "/docs/observability/aws/deploy-use-aws-observability/before-you-deploy": "/docs/observability/aws/deploy-use-aws-observability/v2.15.0/before-you-deploy", | |||
There was a problem hiding this comment.
All the new AWSO redirects here point to v2.15.0, never v3.0.0. Presumably intentional (keep legacy/bookmarked URLs landing on the stable version during rollout) — just flagging to confirm, since v3.0.0 is being presented as "latest" elsewhere in this PR.
4 participants
Purpose of this pull request
This pull request...
Select the type of change
Ticket (if applicable)