Various references broken (mainly to reference architecture)

cloudposse / terraform-aws-components

Opinionated, self-contained Terraform root modules that each solve one, specific problem

https://docs.cloudposse.com/components/

Apache License 2.0

496 stars 211 forks source link

Various references broken (mainly to reference architecture) #747

Closed hans-d closed 10 months ago

hans-d commented 1 year ago

Found a bug? Maybe our Slack Community can help.

Describe the Bug

Various broken links: (https://github.com/cloudposse/terraform-aws-components/blob/a63341e8fb54178294c4f42be78a9b2e0c205870/modules/account-map/README.md?plain=1#L7)

Expected Behavior

Valid links

osterman commented 1 year ago

Please note this documentation is Docusarus markdown and is the static documentation rendered to docs.cloudposse.com.

All links are validated via CI and working.

We are unable to manage duplicate copies of documentation on GitHub markdown as well as Docusarus markdown, as it would lead to confusion as to which copy to edit, resulting in PRs to generated content.

osterman commented 1 year ago

Here is the corresponding link to the referenced example. https://docs.cloudposse.com/components/library/aws/account-map/

Also, it's worth mentioning that we use relative links so that they work in ephemeral preview environments of PRs.

osterman commented 1 year ago

Apologies, but it does appear that our public links are not validated. I see the broken links as well. Will get fixed asap.

milldr commented 10 months ago

resolved by #749