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.

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

Update cockroachcloud/ links to use Liquid syntax #18844

Merged
merged 2 commits into from
Aug 21, 2024

Conversation

rmloveland
Copy link
Contributor

@rmloveland rmloveland commented Aug 20, 2024

Addresses the part of DOC-10953 that can be accomplished 99.9% mechanically

Note: This does not touch releases/ or molt/ but those are much smaller. I suspect releases/ will be a bit more complicated due to the whole versioning situation, so that will be easier to do in another targeted PR. It also does not touch any non-Liquid URLs which are being used inside HTML markup.

All but a few of the edits in this PR were accomplished with the following one-liners, which were run separately in every version subdirectory (e.g. v24.2) and every include subdirectory (e.g. _includes/v24.2).

The mechanical changes revealed 2 broken anchor links in authorization.md and migration-overview.md (identical across several versions) which needed 6-8 manual edits.

One-liner for non-Liquid Markdown links without anchors:

perl -p -i -e 's{\(https://www.cockroachlabs.com/docs/cockroachcloud/([a-z\-]+)\)}{({% link cockroachcloud/$1.md %})}g' *.md

One-liner for non-Liquid Markdown links with anchors:

perl -p -i -e 's{\(https://www.cockroachlabs.com/docs/cockroachcloud/([a-z\-]+)#([a-z\-0-9]+)\)}{({% link cockroachcloud/$1.md %}#$2)}g' *.md

Copy link

Files changed:

Copy link

netlify bot commented Aug 20, 2024

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 69d9a8d
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/66c62cf4f84c460008fb8ba8

Copy link

netlify bot commented Aug 20, 2024

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 69d9a8d
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/66c62cf4c96a700008b110bd

Copy link

netlify bot commented Aug 20, 2024

Netlify Preview

Name Link
🔨 Latest commit 69d9a8d
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/66c62cf42910830008849dd7
😎 Deploy Preview https://deploy-preview-18844--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@rmloveland rmloveland enabled auto-merge (squash) August 21, 2024 18:08
@rmloveland rmloveland merged commit 4018a61 into main Aug 21, 2024
7 checks passed
@rmloveland rmloveland deleted the 20240820-DOC-10953-use-liquid-links branch August 21, 2024 18:13
mdlinville added a commit that referenced this pull request Aug 21, 2024
mdlinville added a commit that referenced this pull request Aug 21, 2024
mdlinville added a commit that referenced this pull request Aug 23, 2024
* Update cockroachcloud/ links in Cloud 2.0 to use Liquid syntax

Relates to DOC-10953
Relates to #18844
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.

2 participants