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

Remove {{}} in Optimize update guide links #4561

Merged
merged 7 commits into from
Nov 4, 2024
Merged

Remove {{}} in Optimize update guide links #4561

merged 7 commits into from
Nov 4, 2024

Conversation

akeller
Copy link
Member

@akeller akeller commented Nov 1, 2024

Description

Related to #2719, fixes build issues by getting docs.camunda.org syntax out.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@akeller akeller added component:docs Documentation improvements, including new or updated content d3 Path to Docusaurus 3 labels Nov 1, 2024
@akeller akeller requested a review from a team November 1, 2024 22:30
@akeller akeller self-assigned this Nov 1, 2024
Copy link
Contributor

github-actions bot commented Nov 1, 2024

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

@akeller
Copy link
Member Author

akeller commented Nov 1, 2024

Oops, sorry for the misleading branch name. I also couldn't easily figure out where this content should point to, so I didn't include links.

@akeller
Copy link
Member Author

akeller commented Nov 4, 2024

If this builds, this will take care of all the links in the docs.camunda.org syntax.

However, there will still be instances where {{< is used, particularly for referencing the version alias (not something we do on docs.camunda.io, but is an interesting idea!). Because these don't break the build, I will leave them for now.

Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

Should these links resolve to the versioned docs? Right now, they're sending me to /next, and I am not sure of the Optimize versioned docs can figure out what version it's in without backing out of the current directory.

@akeller akeller added the deploy Stand up a temporary docs site with this PR label Nov 4, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs November 4, 2024 19:04 Destroyed
@akeller
Copy link
Member Author

akeller commented Nov 4, 2024

Should these links resolve to the versioned docs? Right now, they're sending me to /next, and I am not sure of the Optimize versioned docs can figure out what version it's in without backing out of the current directory.

This does look like a bug. Given the links didn't resolve at all previously, but now go to a page that exists, I think it's a risk I'm willing to accept. Also these versions are technically too old to be supported and the C7 docs will move back to docs.camunda.org soon.

Any concerns with my logic here @conceptualshark?

@conceptualshark
Copy link
Contributor

👍 Works for me - happy to approve!

@akeller akeller merged commit 537304d into main Nov 4, 2024
10 checks passed
@akeller akeller deleted the optimize-7-syntax branch November 4, 2024 20:11
Copy link
Contributor

github-actions bot commented Nov 4, 2024

🧹 Preview environment for this PR has been torn down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content d3 Path to Docusaurus 3 deploy Stand up a temporary docs site with this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants