Skip to content

Backport of docs: Migrate link formats into stable-website#16061

Merged
im2nguyen merged 2 commits intostable-websitefrom
backport/docs/amb.migrate-link-formats/carefully-hot-stud
Feb 9, 2023
Merged

Backport of docs: Migrate link formats into stable-website#16061
im2nguyen merged 2 commits intostable-websitefrom
backport/docs/amb.migrate-link-formats/carefully-hot-stud

Conversation

@hc-github-team-consul-core
Copy link
Copy Markdown
Collaborator

Backport

This PR is auto-generated from #15976 to be assessed for backporting due to the inclusion of the label type/docs-cherrypick.

WARNING automatic cherry-pick of commits failed. Commits will require human attention.

merge conflict error: POST https://api.github.com/repos/hashicorp/consul/merges: 409 Merge conflict []

The below text is copied from the body of the original PR.


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.

PRs that came before this as pre-work

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)


Overview of commits

@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/docs/amb.migrate-link-formats/carefully-hot-stud branch from 91d2f07 to 65877fb Compare January 25, 2023 16:53
@hashicorp-cla
Copy link
Copy Markdown

hashicorp-cla commented Jan 25, 2023

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes


1 out of 2 committers have signed the CLA.

  • ashleemboyer
  • temp

temp seems not to be a GitHub user.
You need a GitHub account to be able to sign the CLA. If you already have a GitHub account, please add the email address used for this commit to your account.

Have you signed the CLA already but the status is still pending? Recheck it.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Auto approved Consul Bot automated PR

@kendallstrautman kendallstrautman marked this pull request as ready for review January 25, 2023 17:22
@kendallstrautman
Copy link
Copy Markdown
Contributor

kendallstrautman commented Jan 26, 2023

Closing, we are waiting until the next release in february to align the latest link rewrites with stable-website

@im2nguyen im2nguyen requested a review from a team as a code owner February 9, 2023 08:28
@im2nguyen im2nguyen merged commit cc469b8 into stable-website Feb 9, 2023
@im2nguyen im2nguyen deleted the backport/docs/amb.migrate-link-formats/carefully-hot-stud branch February 9, 2023 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants