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

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

Merged
merged 10 commits into from
Jul 28, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7d7edc3
chore(deps): update docusaurus from beta-18 to beta-19
pepopowitz Jul 19, 2022
2921be7
fix(ui): remove bullets from footer nav, which were introduced by an …
pepopowitz Jul 20, 2022
e2e15be
chore(deps): update broken markdown links for latest version
pepopowitz Jul 25, 2022
3a5e14f
chore(deps): update broken markdown links for 0.26
pepopowitz Jul 25, 2022
f997793
chore(deps): update broken markdown links for 1.0
pepopowitz Jul 25, 2022
1f3ea5e
chore(deps): update broken markdown links for 1.1
pepopowitz Jul 25, 2022
cceaf0e
chore(deps): update broken markdown links for 1.2
pepopowitz Jul 25, 2022
300f9ee
chore(deps): update broken markdown links for 1.3
pepopowitz Jul 25, 2022
f0e7fce
chore(deps): throw errors on broken markdown links
pepopowitz Jul 25, 2022
c883f95
chore(deps): update docusaurus from beta-19 to beta-20
pepopowitz Jul 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/apis-clients/cli-client/cli-get-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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

![processId](./assets/zeebe-modeler-advanced-process-id.png)

Expand Down Expand Up @@ -93,7 +93,7 @@ Use the following conditional expression for the **else** sequence flow:

## Deploy a process

Now, you can deploy the [process](./assets/gettingstarted_quickstart_advanced.bpmn). Navigate to the folder where you saved your process.
Now, you can deploy the [process](assets/gettingstarted_quickstart_advanced.bpmn). Navigate to the folder where you saved your process.

```bash
zbctl deploy resource gettingstarted_quickstart_advanced.bpmn
Expand Down
2 changes: 1 addition & 1 deletion docs/components/components-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ This section contains product manual content for each component in Camunda Platf

:::note Looking for deployment guides?

Deployment guides for Camunda Platform 8 components are available in the [Self-Managed section](./self-managed/about-self-managed.md).
Deployment guides for Camunda Platform 8 components are available in the [Self-Managed section](/self-managed/about-self-managed.md).

:::
2 changes: 1 addition & 1 deletion docs/components/concepts/incidents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,4 @@ client.newResolveIncidentCommand(incident.getKey())
When the incident is resolved, the process instance continues.

- [Operate](/components/operate/operate-introduction.md)
- [APIs and Clients](./apis-clients/working-with-apis-clients.md)
- [APIs and Clients](/apis-clients/working-with-apis-clients.md)
2 changes: 1 addition & 1 deletion docs/components/concepts/job-workers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

4 changes: 2 additions & 2 deletions docs/components/concepts/process-instance-creation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,5 +111,5 @@ A process can also have one or more [timer start events](/components/modeler/bpm

## Next steps

- [About Modeler](./components/modeler/about-modeler.md)
- [Automating a process using BPMN](./guides/automating-a-process-using-bpmn.md)
- [About Modeler](/components/modeler/about-modeler.md)
- [Automating a process using BPMN](/guides/automating-a-process-using-bpmn.md)
4 changes: 2 additions & 2 deletions docs/components/concepts/processes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,5 +81,5 @@ The diamond shape with the **+** marker means all outgoing paths are activated.

## Next steps

- [About Modeler](./components/modeler/about-modeler.md)
- [Automating a process using BPMN](./guides/automating-a-process-using-bpmn.md)
- [About Modeler](/components/modeler/about-modeler.md)
- [Automating a process using BPMN](/guides/automating-a-process-using-bpmn.md)
4 changes: 2 additions & 2 deletions docs/components/console/introduction-to-console.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

- [Manage alerts](./manage-clusters/manage-alerts.md) to get notified when workflow errors occur.
- [Manage IP Whitelists](./manage-clusters/manage-ip-whitelists.md) to restrict access to clusters.
- [Manage](./manage-organization/organization-settings.md) your organization.
- [Console API clients (REST)](./apis-clients/console-api-reference.md) to manage clusters programmatically.
- [Console API clients (REST)](/apis-clients/console-api-reference.md) to manage clusters programmatically.

If you don't have a Camunda Platform 8 account yet, visit our [Getting Started Guide](../../guides/create-account.md).
4 changes: 2 additions & 2 deletions docs/components/modeler/about-modeler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ In this guide, we'll demonstrate modeling BPMN diagrams using both Web Modeler a

## Next steps

- [Modeling BPMN](./guides/automating-a-process-using-bpmn.md) - Learn how to quickly model an automated process using BPMN.
- [Camunda Forms](./guides/utilizing-forms.md) - Allows you to easily design and configure forms. Once configured, they can be connected to a user task or start event to implement a task form in your application.
- [Modeling BPMN](/guides/automating-a-process-using-bpmn.md) - Learn how to quickly model an automated process using BPMN.
- [Camunda Forms](/guides/utilizing-forms.md) - Allows you to easily design and configure forms. Once configured, they can be connected to a user task or start event to implement a task form in your application.
- [DMN](./dmn/dmn.md) - In DMN, decisions can be modeled and executed using the same language. Business analysts can model the rules that lead to a decision in easy to read tables, and those tables can be executed directly by a decision engine (like Camunda).
2 changes: 1 addition & 1 deletion docs/components/zeebe/technical-concepts/technical-concepts-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ This section gives an overview of Zeebe's underlying technical concepts.
- [Process lifecycles](process-lifecycles.md) - Expands on the event processing concept and goes into more detail regarding the lifecycles of selected process elements.
- [Protocols](protocols.md) - Explains how external clients communicate with Zeebe.

In addition to these sections, you may also be interested in our [Best Practices](././components/best-practices/best-practices-overview.md).
In addition to these sections, you may also be interested in our [Best Practices](/components/best-practices/best-practices-overview.md).
10 changes: 5 additions & 5 deletions docs/guides/automating-a-process-using-bpmn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ BPMN offers control and visibility over your critical business processes. The wo
## Set up

Begin by building your BPMN diagrams with [Modeler](../components/modeler/about-modeler.md).
To get started, ensure you’ve [created a Camunda Platform 8 account](./guides/create-account.md).
To get started, ensure you’ve [created a Camunda Platform 8 account](/guides/create-account.md).

## Getting started with BPMN

Expand Down Expand Up @@ -85,9 +85,9 @@ To execute your completed process diagram, click the blue **Deploy diagram** but

You can now start a new process instance to initiate your process diagram. Click the blue **Start instance** button.

You can now monitor your instances in [Operate](./components/operate/operate-introduction.md). From your diagram, click the honeycomb icon button next to the **Start instance** button, and **View process instances**. This will automatically take you to Camunda Operate to monitor your running instances.
You can now monitor your instances in [Operate](/components/operate/operate-introduction.md). From your diagram, click the honeycomb icon button next to the **Start instance** button, and **View process instances**. This will automatically take you to Camunda Operate to monitor your running instances.

You can also visit an ongoing list of user tasks required in your BPMN diagram. Click the honeycomb icon button next to the **Start instance** button, and **View user tasks** to automatically be taken to [Tasklist](./components/tasklist/introduction-to-tasklist.md).
You can also visit an ongoing list of user tasks required in your BPMN diagram. Click the honeycomb icon button next to the **Start instance** button, and **View user tasks** to automatically be taken to [Tasklist](/components/tasklist/introduction-to-tasklist.md).

:::note
Variables are part of a process instance and represent the data of the instance. To learn more about these values, variable scope, and input/output mappings, visit our documentation on [variables](../components/concepts/variables.md).
Expand All @@ -99,5 +99,5 @@ Variables are part of a process instance and represent the data of the instance.
- [BPMN Implementation Reference](https://docs.camunda.org/manual/latest/reference/bpmn20/)
- [BPMN Engine](https://camunda.com/products/camunda-platform/bpmn-engine/)
- [BPMN Reference](../components/modeler/bpmn/bpmn.md)
- [Operate](./components/operate/operate-introduction.md)
- [Tasklist](./components/tasklist/introduction-to-tasklist.md)
- [Operate](/components/operate/operate-introduction.md)
- [Tasklist](/components/tasklist/introduction-to-tasklist.md)
4 changes: 2 additions & 2 deletions docs/guides/implementing-connectors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Connectors technically consist of two parts: the business logic is implemented a

## Set up

We'll implement our connector with [Modeler](../components/modeler/about-modeler.md). To get started, ensure you’ve [created a Camunda Platform 8 account](./guides/create-account.md).
We'll implement our connector with [Modeler](../components/modeler/about-modeler.md). To get started, ensure you’ve [created a Camunda Platform 8 account](/guides/create-account.md).

You'll also need to [create a SendGrid account](https://signup.sendgrid.com/) if you don't have one already, as we'll use SendGrid in our example connector. Once you've created your account, you will immediately be prompted to create a [sender](https://docs.sendgrid.com/ui/sending-email/senders).

Expand Down Expand Up @@ -78,7 +78,7 @@ To execute your completed process diagram, click **Deploy diagram**.

You can now start a new process instance to initiate your process diagram. Click **Start instance**.

You can now monitor your instances in [Operate](./components/operate/operate-introduction.md). From your diagram, click the honeycomb icon button next to the **Start instance** button, and **View process instances**. This will automatically take you to Operate to monitor your running instances.
You can now monitor your instances in [Operate](components/operate/operate-introduction.md). From your diagram, click the honeycomb icon button next to the **Start instance** button, and **View process instances**. This will automatically take you to Operate to monitor your running instances.

:::note
Variables are part of a process instance and represent the data of the instance. To learn more about these values, variable scope, and input/output mappings, visit our documentation on [variables](../components/concepts/variables.md).
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/utilizing-forms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ While you can incorporate Camunda Forms solely within Camunda Platform 8, you ca

### Create new form

To start building a form, log in to your [Camunda Platform 8](https://camunda.io) account or open [Desktop Modeler](./components/modeler/about-modeler.md) and take the following steps:
To start building a form, log in to your [Camunda Platform 8](https://camunda.io) account or open [Desktop Modeler](/components/modeler/about-modeler.md) and take the following steps:

1. Click on the **Modeler** tab at the top of the page or alternatively open the **File** menu in Desktop Modeler.
2. Open any project from your Web Modeler home view.
Expand Down Expand Up @@ -92,5 +92,5 @@ To deploy with Camunda Platform 7, use the [process engine](https://docs.camunda

## Additional resources

- [Desktop and Web Modeler](./components/modeler/about-modeler.md)
- [User task reference](./components/modeler/bpmn/user-tasks/user-tasks.md)
- [Desktop and Web Modeler](/components/modeler/about-modeler.md)
- [User task reference](/components/modeler/bpmn/user-tasks/user-tasks.md)
2 changes: 1 addition & 1 deletion docs/reference/glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ A correlation is an attribute within a message used to match this message agains

A process cannot execute unless it is known by the broker. Deployment is the process of pushing or deploying processes to the broker.

- [Zeebe Deployment](./self-managed/about-self-managed.md)
- [Zeebe Deployment](/self-managed/about-self-managed.md)

### Event

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/supported-environments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: "Find out where to run Camunda Platform 8 components for SaaS and S
- **Zeebe Go Client**: Go 1.13+
- **zbctl**: Windows, MacOS, and Linux (latest)

_Hint: There are more [community-maintained Camunda Platform 8 clients](./apis-clients/community-clients/index.md)._
_Hint: There are more [community-maintained Camunda Platform 8 clients](/apis-clients/community-clients/index.md)._

### Web Browser

Expand Down
1 change: 1 addition & 0 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ module.exports = {
// baseUrl: "/camunda-cloud-documentation/",
baseUrl: "/",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "throw",
favicon: "img/favicon.ico",
organizationName: "camunda-cloud", // Usually your GitHub org/user name.
projectName: "camunda-cloud-documentation", // Usually your repo name.
Expand Down
Loading