Skip to content
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

Jump to bottom

docs: Migrate link formats #13048

Merged
merged 4 commits into from
Jan 20, 2023
Merged

docs: Migrate link formats #13048

merged 4 commits into from
Jan 20, 2023

Conversation

ashleemboyer
Copy link
Contributor

@ashleemboyer ashleemboyer commented Jan 5, 2023 •
edited
Loading

What

  • Migrates the formats of links in Markdown content as part of the Docs Content Link Rewrites project
  • Adds two new GitHub workflow files:
    • .github/workflows/check-legacy-links-format.yml - This is a workflow that checks if links in markdown content are in the new format. It does this by running the link rewrite script from dev-portal, and then asserting that no "rewriteable" links were found. This workflow will be used on subsequent PRs to maintain the new link format.
    • .github/workflows/test-link-rewrites.yml - This is a workflow that executes e2e tests of this PR's changes against the main branch's deploy preview. The tests only run for branches named docs/amb.migrate-link-formats, so future PRs will not have the tests run against them. This is a temporary workflow.

Reviewing

With the two new workflows in place, this PR should only need a spot-check.

Testing

  • The latest run of the "Legacy Link Format Checker" workflow for this branch should pass (check here)
  • The latest run of the "Test Link Rewrites" workflow for this branch should pass (check here)

@ashleemboyer ashleemboyer force-pushed the docs/amb.migrate-link-formats branch from 06a8f5b to 2fdca41 Compare January 5, 2023 23:08
@vercel
Copy link

vercel bot commented Jan 5, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
vagrant 🔄 Building (Inspect) Jan 5, 2023 at 11:57PM (UTC)

@ashleemboyer ashleemboyer force-pushed the docs/amb.migrate-link-formats branch from 609cffd to 455cbff Compare January 10, 2023 23:25
@ashleemboyer ashleemboyer force-pushed the docs/amb.migrate-link-formats branch from cae3076 to f4482d7 Compare January 11, 2023 00:24
@ashleemboyer ashleemboyer force-pushed the docs/amb.migrate-link-formats branch from f4482d7 to e75a8ad Compare January 11, 2023 23:18
@ashleemboyer ashleemboyer force-pushed the docs/amb.migrate-link-formats branch from e75a8ad to bd3a8b2 Compare January 12, 2023 00:11
@ashleemboyer ashleemboyer changed the title docs: Migrate link formats [WIP 🚧] docs: Migrate link formats Jan 13, 2023
@ashleemboyer ashleemboyer force-pushed the docs/amb.migrate-link-formats branch from bd3a8b2 to e2e0339 Compare January 18, 2023 22:31
@ashleemboyer ashleemboyer changed the title [WIP 🚧] docs: Migrate link formats docs: Migrate link formats Jan 18, 2023
@ashleemboyer ashleemboyer marked this pull request as ready for review January 18, 2023 22:57
kendallstrautman
kendallstrautman reviewed Jan 18, 2023
View reviewed changes
website/content/intro/vs/terraform.mdx
@@ -33,4 +33,4 @@ Vagrant is for development environments. Terraform is for more general
infrastructure management.

[hashicorp]: https://www.hashicorp.com
[terraform]: https://www.terraform.io
Copy link
Contributor

Choose a reason for hiding this comment

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

We should leave this link to the .io site homepage no?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sharing an update for posterity: we're chatting about this in Slack and confirming how we want to handle these links

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Update since dev-portal#1549 was merged:

  • Links to .io home pages are not rewritten
  • / links are also not rewritten (to enable linking to Dev Dot home page)

@ashleemboyer ashleemboyer added the backport/website Backport changes into `stable-website` label Jan 18, 2023
topfunky
topfunky previously approved these changes Jan 19, 2023
View reviewed changes
Copy link
Contributor

@topfunky topfunky left a comment

Choose a reason for hiding this comment

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

👍🏻

tunzor
tunzor previously approved these changes Jan 19, 2023
View reviewed changes
Copy link
Contributor

@tunzor tunzor left a comment

Choose a reason for hiding this comment

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

🚀

soapy1
soapy1 previously approved these changes Jan 19, 2023
View reviewed changes
@ashleemboyer
Copy link
Contributor Author

We have some new information about a certain type of link that's getting rewritten (links to .io home pages). There's a quick change we need to make to the link rewrite script we're using, and the server-side link rewriter we use on dev-portal. It should be addressed in a few hours, and I'm going to convert this PR to draft so it's not merged before we've made these updates. 😊

@ashleemboyer ashleemboyer marked this pull request as draft January 19, 2023 17:56
@kendallstrautman kendallstrautman dismissed stale reviews from soapy1, tunzor, and topfunky via cb582ee January 20, 2023 00:28
@kendallstrautman kendallstrautman force-pushed the docs/amb.migrate-link-formats branch from e2e0339 to cb582ee Compare January 20, 2023 00:28
@kendallstrautman kendallstrautman force-pushed the docs/amb.migrate-link-formats branch from 179466f to cb582ee Compare January 20, 2023 00:55
@ashleemboyer ashleemboyer mentioned this pull request Jan 20, 2023
Merged
@ashleemboyer ashleemboyer marked this pull request as ready for review January 20, 2023 18:28
@ashleemboyer
Copy link
Contributor Author

@topfunky @tunzor @soapy1 this PR is now ready for re-review!

Here's a comment with the latest on what's changed: #13048 (comment)

tunzor
tunzor approved these changes Jan 20, 2023
View reviewed changes
Copy link
Contributor

@tunzor tunzor left a comment

Choose a reason for hiding this comment

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

👍

@ashleemboyer ashleemboyer merged commit 24a830a into main Jan 20, 2023
@vagrant-bot vagrant-bot mentioned this pull request Jan 20, 2023
Merged
2 tasks
This was referenced Jan 20, 2023
Merged
Open
Merged
Closed
Closed
Closed
Closed
Closed
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 20, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@kendallstrautman kendallstrautman kendallstrautman left review comments

@tunzor tunzor tunzor approved these changes

@soapy1 soapy1 soapy1 approved these changes

@topfunky topfunky Awaiting requested review from topfunky

Assignees
No one assigned
Labels
backport/website Backport changes into `stable-website` website
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ashleemboyer @topfunky @soapy1 @tunzor @kendallstrautman