Skip to content
This repository has been archived by the owner on Jan 8, 2024. It is now read-only.

website/docs: Fix markdown links #4793

Closed
wants to merge 1 commit into from

Conversation

tired-engineer
Copy link

Fix reference-style links in app stanza description.

@tired-engineer tired-engineer requested a review from a team as a code owner June 10, 2023 21:48
@digital-content-events
Copy link

📄 Content Checks

Updated: Sat, 10 Jun 2023 21:48:47 GMT

Found 5 error(s)

content/docs/waypoint-hcl/app.mdx

Position Description Rule
124:1-124:49 Unexpected product-relative link: /docs/waypoint-hcl/build. Ensure that relative links are fully-qualified Developer paths: /{productSlug}/docs/waypoint-hcl/build ensure-valid-link-format
125:1-125:52 Unexpected product-relative link: /docs/waypoint-hcl/deploy. Ensure that relative links are fully-qualified Developer paths: /{productSlug}/docs/waypoint-hcl/deploy ensure-valid-link-format
126:1-126:55 Unexpected product-relative link: /docs/waypoint-hcl/release. Ensure that relative links are fully-qualified Developer paths: /{productSlug}/docs/waypoint-hcl/release ensure-valid-link-format
127:1-127:52 Unexpected product-relative link: /docs/waypoint-hcl/runner. Ensure that relative links are fully-qualified Developer paths: /{productSlug}/docs/waypoint-hcl/runner ensure-valid-link-format
128:1-128:43 Unexpected product-relative link: /docs/waypoint-hcl/url. Ensure that relative links are fully-qualified Developer paths: /{productSlug}/docs/waypoint-hcl/url ensure-valid-link-format

Comment on lines +124 to +128
[build]: /docs/waypoint-hcl/build 'Build Stanza'
[deploy]: /docs/waypoint-hcl/deploy 'Deploy Stanza'
[release]: /docs/waypoint-hcl/release 'Release Stanza'
[runner]: /docs/waypoint-hcl/runner 'Runner Stanza'
[url]: /docs/waypoint-hcl/url 'url Stanza'
Copy link
Contributor

@anGie44 anGie44 Aug 17, 2023

Choose a reason for hiding this comment

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

Wow ran into this today, ty! Just a a bystander note (not a reviewer), i think the links need to have "/waypoint" prepended i.e.

Suggested change
[build]: /docs/waypoint-hcl/build 'Build Stanza'
[deploy]: /docs/waypoint-hcl/deploy 'Deploy Stanza'
[release]: /docs/waypoint-hcl/release 'Release Stanza'
[runner]: /docs/waypoint-hcl/runner 'Runner Stanza'
[url]: /docs/waypoint-hcl/url 'url Stanza'
[build]: /waypoint/docs/waypoint-hcl/build 'Build Stanza'
[deploy]: /waypoint/docs/waypoint-hcl/deploy 'Deploy Stanza'
[release]: /waypoint/docs/waypoint-hcl/release 'Release Stanza'
[runner]: /waypoint/docs/waypoint-hcl/runner 'Runner Stanza'
[url]: /waypoint/docs/waypoint-hcl/url 'url Stanza'

to make the content checks happy 😄

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants