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

chore(deps): update docusaurus from beta-18 to beta-20 #1085

Merged
merged 10 commits into from
Jul 28, 2022

Conversation

pepopowitz
Copy link
Collaborator

Partially addresses #1024

This PR updates docusaurus dependencies from beta-18 to beta-20. It includes multiple side-quests due to breaking changes:

The build warnings introduced by beta-19

image

Proof that the build warnings disappear in beta-20

image

Unrelated: a funny error message I got from VS Code while resolving rebase conflicts for this PR

"Terminal is dumb," git says with a pouty face.

image

@pepopowitz pepopowitz self-assigned this Jul 26, 2022
@@ -65,7 +65,7 @@ Brokers:

## Advanced process

Use [this process model](./assets/gettingstarted_quickstart_advanced.bpmn) for the tutorial.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I don't actually think I needed to update this...both the left and right version are treated the same. I probably did this as an experiment early on, while learning which relative paths I needed to worry about.

I can undo this change if people would like; it is a harmless change, though.

@@ -77,4 +77,4 @@ The fact that jobs may be worked on more than once means that Zeebe is an "at le

## Next steps

- [Zeebe overview](./components/zeebe/zeebe-overview.md)
- [Zeebe overview](components/zeebe/zeebe-overview.md)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Note that docusaurus doesn't care whether the absolute path starts with / or not -- this will look for the linked doc from the root, just as the others that start with / do.

It's accidental that this one doesn't contain a slash, though. I tried to be consistent about specifying / throughout the PR. If people would like me to add a / here, I would, though I personally don't care enough to change it until requested.

Copy link
Member

Choose a reason for hiding this comment

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

Usually, I vote for consistency, but I'm okay with leaving this / or no / as long as the behavior is consistent. Thanks for calling this out, though! And FYI @christinaausley, this is a good topic to catch during code reviews as we see changes come through but I don't think we need to address this immediately.

@@ -8,10 +8,10 @@ Camunda Platform Console is the management application for the included products
Using Camunda Platform Console, you can do the folllowing:

- [Create](./manage-clusters/create-cluster.md) and [delete](./manage-clusters/delete-cluster.md) clusters.
- [Manage API clients](./manage-clusters/manage-api-clients.md) to interact with [Zeebe](./components/zeebe/zeebe-overview.md) and [Tasklist](./components/tasklist/introduction-to-tasklist.md).
- [Manage API clients](./manage-clusters/manage-api-clients.md) to interact with [Zeebe](/components/zeebe/zeebe-overview.md) and [Tasklist](/components/tasklist/introduction-to-tasklist.md).
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Note that the first link in this sentence is still relative, because the linked doc is actually a child.

@akeller
Copy link
Member

akeller commented Jul 26, 2022

First - congrats on getting your face on the d- 🦖 docs release! That's awesome! Thanks for helping others in the broader tech community.

Second - I mentioned this during our time this morning but feel free to pause these updates whenever makes sense to you and shift to the versioning work. I know you don't need my permission, but I figured I'd mention it publicly anyway in case someone is like "wait... but it's still not up to date!"

Copy link
Member

@akeller akeller left a comment

Choose a reason for hiding this comment

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

I'm good with these changes. When this gets merged, please announce it in the ask-documentation channel, particularly since the link behavior is different and I'm not sure folks are in the habit of updating the local setup to get the changes on main.

@akeller akeller added component:docs Documentation improvements, including new or updated content dx Documentation infrastructure typically handled by the Camunda DX team labels Jul 26, 2022
@pepopowitz pepopowitz merged commit 3540b7f into main Jul 28, 2022
@pepopowitz pepopowitz deleted the pepopowitz/1024-beta-18-to-20 branch July 28, 2022 15:22
lzgabel pushed a commit to lzgabel/camunda-platform-docs that referenced this pull request Aug 9, 2022
* chore(deps): update docusaurus from beta-18 to beta-19

* fix(ui): remove bullets from footer nav, which were introduced by an infima update in docusaurus beta-19

* chore(deps): update broken markdown links for latest version

* chore(deps): update broken markdown links for 0.26

* chore(deps): update broken markdown links for 1.0

* chore(deps): update broken markdown links for 1.1

* chore(deps): update broken markdown links for 1.2

* chore(deps): update broken markdown links for 1.3

* chore(deps): throw errors on broken markdown links

* chore(deps): update docusaurus from beta-19 to beta-20
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 dx Documentation infrastructure typically handled by the Camunda DX team
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants