Release 0.26

README.md

@@ -1,159 +1,30 @@
-# Camunda Cloud Documentation
+<div align="center">
+<img src="./static/img/camunda-cloud-logo.png" width="200px"/>
 
-This documentation is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
+<h1>Camunda Cloud Documentation</h1>
+<p>
+This repository contains the Camunda Cloud documentation, which can be found at <a href="https://docs.camunda.io/" target="_blank">https://docs.camunda.io/</a>.
+</p>
+</div>
 
-## Rights
+---
 
-`OWNERS` files in various folders define who needs to approve changes within this folder. Approvers can approve a PR by adding the comment `/lgtm`.
+[![development guidelines](./howtos/documentation-guidelines.svg)](./howtos/documentation-guidelines.md)
 
-## Setup
+[![technical writing cheatsheet](./howtos/technical-writing-cheatsheet.svg)](./howtos/technical-writing-cheatsheet.md)
 
-### Installation
+---
 
-```bash
-npm i
-```
+[![release procedure](./howtos/release-procedure.svg)](./howtos/release-procedure.md)
 
-### Local Development
+[![publish documentation](./howtos/publish-documentation.svg)](./howtos/publish-documentation.md)
 
-```bash
-npm run start
-```
+---
 
-This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
+[![setup](./howtos/setup.svg)](./howtos/setup.md)
 
-### Build
+[![configuration](./howtos/configuration.svg)](./howtos/configuration.md)
 
-```bash
-npm run build
-```
+[![configuration](./howtos/versioning.svg)](./howtos/versioning.md)
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
-
-### Deployment
-
-```bash
-$ GIT_USER=<Your GitHub username> USE_SSH=true npm run deploy
-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
-
-## Publish documentation
-
-Publishing the documentation works by adding a new semver tag (`x.y.z`). [This Github Workflow](./.github/workflows/publish.yaml) will be triggered to build and deploy the docs.
-
-Github Page available under [https://camunda-cloud.github.io/camunda-cloud-documentation/](https://camunda-cloud.github.io/camunda-cloud-documentation/).
-
-## Search by Algolia
-
-- API-Key and Index name is configured in `./docusaurus.config.js`.
-
-## Documentation Guidelines
-
-### PRs for every change
-
-All changes have to be done in a separate Branch. As soon as the changes are done please open a PR. A Github Action runs with every commit to a Branch and checks if the documentation can be build (including a broken links check).
-
-### Structure
-
-- Name Markdown files according to the title. This makes it easier to find a file. Example: **Introduction to Camunda Cloud** --> `introduction-to-camunda-cloud.md`. Use the file name as internal document id to reference in `sidebars.js`.
-- Sub catagories have to be placed in their own sub directories. Example: Guides/Getting Started can be found in `docs/guides/getting-started`.
-
-### Adding a new documentation page
-
-1. Select the corresponding directory
-2. Add the document id to [`sidebars.js`](./sidebars.js)
-
-### Images
-
-- Static images can be placed into [`static/img/`](./static/img/).
-- Images that will change with a new version have to be placed into `docs`. Best practice: add an `img` directory to each directory where it is needed.
-
-### Videos
-
-- The regular `video` does not work in MDX.
-- Use the [react-video](https://www.npmjs.com/package/react-player) component in the following way:
-
-Import the component into corresponding Markdown file:
-
-```js
-import ReactPlayer from 'react-player'
-```
-
-Embed a video with the `react-video` component:
-
-```html
-<ReactPlayer
-playing
-loop
-playsinline
-height="200px"
-url={[
-{src: './video.mp4', type: 'video/mp4'}
-]}
-/>
-```
-
-### Code Blocks / Selector
-
-Docusaurus supports [MDX](https://mdxjs.com/) that makes it easily possible to use code selectors for our docs. Two things need to be done:
-
-Import the needed libraries to the markdown file:
-
-```js
-import Tabs from "@theme/Tabs";
-import TabItem from "@theme/TabItem";
-```
-
-Define code blocks:
-
-```html
-<Tabs groupId="language" defaultValue="cli" values={[ { label: 'CLI', value: 'cli', }, ] }>
-
-<TabItem value="cli">
-code
-</TabItem>
-
-</Tabs>
-```
-
-Hint: `groupId="language"` sets the decision documentation-wide. Can also be used for other use cases like different Tabs for different operating systems.
-
-Template:
-
-```html
-<Tabs groupId="language" defaultValue="csharp" values={
-[
-{ label: 'C# / ASP.NET Core 3', value: 'csharp', },
-{ label: 'Go', value: 'go', },
-{ label: 'Java', value: 'java', },
-{ label: 'Java + Spring', value: 'javaspring', },
-{ label: 'Kotlin + Spring', value: 'kotlin', },
-{ label: 'NodeJS', value: 'nodejs', },
-] }>
-
-<TabItem value="csharp">
-</TabItem>
-
-<TabItem value="go">
-</TabItem>
-
-<TabItem value="java">
-</TabItem>
-
-<TabItem value="javaspring">
-</TabItem>
-
-<TabItem value="kotlin">
-</TabItem>
-
-<TabItem value="nodejs">
-</TabItem>
-
-</Tabs>
-```
-
-### Source Files for Images and Videos
-Source files for images and videos can be put in:
-
-`./media-src/[subfolder according to do structure]/` 
+[![markdown and mdx features](./howtos/markdown-and-mdx-features.svg)](./howtos/markdown-and-mdx-features.md)

docs/guides/getting-started/connect-to-your-cluster.md

@@ -1,45 +1,20 @@
 ---
 id: connect-to-your-cluster
-title: Connect to your Cluster
+title: Connect to your cluster
 ---
 
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
 ## Installation
 
 Install the appropriate package.
 
-<Tabs
-defaultValue="cli"
-values={[
-{ label: 'CLI', value: 'cli', },
-]
-}>
-
-<TabItem value="cli">
-
 ```bash
 npm i -g zbctl
 ```
 
-</TabItem>
-
-</Tabs>
-
 ## First connection
 
 After creating a client and downloading the connection file, you will now need to source it to make it available in your environment. If these are known to the system, a client can communicate directly with its own cluster in the cloud without further configuration.
 
-<Tabs
-defaultValue="cli"
-values={[
-{ label: 'CLI', value: 'cli', },
-]
-}>
-
-<TabItem value="cli">
-
 ```bash
 source ~/Downloads/CamundaCloudMgmtAPI-Client-test-client.txt
 ```
@@ -48,11 +23,7 @@ source ~/Downloads/CamundaCloudMgmtAPI-Client-test-client.txt
 zbctl status
 ```
 
-</TabItem>
-
-</Tabs>
-
-As a result you will get a similar result:
+As a result you will get a similar response:
 
 ```bash
 Cluster size: 1

docs/guides/getting-started/create-camunda-cloud-account.md

@@ -1,6 +1,6 @@
 ---
 id: create-camunda-cloud-account
-title: Create Camunda Cloud Account
+title: Create Camunda Cloud account
 ---
 
 ## Sign up for Camunda Cloud

docs/guides/getting-started/create-cluster.md

@@ -1,19 +1,19 @@
 ---
 id: create-cluster
-title: Create a Cluster
+title: Create a cluster
 ---
 
 After login you'll see the console overview page. Since you haven't created a cluster, the overview will be empty.
 
 ![cluster-creating](./img/cluster-overview-empty.png)
 
-In the upper right area you'll find the button _Create New Cluster_. Click on it to create a new cluster. After you've assigned a name and created the cluster, a new entry appears in the overview:
+In the upper right area click **Create New Cluster**. After you've assigned a name and created the cluster, a new entry appears in the overview:
 
 ![cluster-creating](./img/cluster-overview-new-cluster-creating.png)
 
 For this Getting Started Tutorial, close the dialog box that pops up immediately after creating a new cluster.
 
-The cluster is now being set up. During this phase, its state is _Creating_. After one or two minutes the cluster is ready for use and changes its state to _healthy_:
+The cluster is now being set up. During this phase, its state is _Creating_. After one or two minutes the cluster is ready for use and changes its state to _Healthy_:
 
 ![cluster-healthy](./img/cluster-overview-new-cluster-healthy.png)
 

docs/guides/getting-started/deploy-your-process-and-start-process-instance.md

@@ -1,6 +1,6 @@
 ---
 id: deploy-your-process-and-start-process-instance
-title: Deploy your process and start a process instance
+title: Deploy and start your process instance
 ---
 
 
@@ -17,19 +17,19 @@ import TabItem from "@theme/TabItem";
 
 <TabItem value='console'>
 
-You can now use the "Save & Deploy" button to deploy the newly created process to your cluster
+You can now use the **Save & Deploy** button to deploy the newly created process to your cluster.
 
 ![console-modeler-deploy](./img/cloud-modeler-deploy.png)
 
-Deployment can take a few seconds, but you should get a confirmation for successfull deployment.
+Deployment can take a few seconds, but you should get a confirmation for successful deployment.
 
 ![console-modeler-deploy-successfull](./img/cloud-modeler-deploy-successfull.png)
 
 You can now start a new process instance. For this example you can just start an instance with an empty payload.
 
 ![console-modeler-start-instance](./img/cloud-modeler-start-instance.png)
 
-Once the instance is started, you'll get a confirmation with a link to jump into Operate directly.
+Once the instance is started, you'll get a confirmation with a button to open Operate.
 
 ![console-modeler-start-instance-done](./img/cloud-modeler-start-instance-done.png)
 
@@ -43,22 +43,22 @@ On the right side of the navigation menu there are buttons for deploying and sta
 
 ![zeebe-modeler-deploy](./img/zeebe-modeler-deploy.png)
 
-In the deployment dialog, the connection information must now be specified: Cluster Id, Client Id and Client Secret.
+In the deployment dialog, the connection information must now be specified: `Cluster Id`, `Client Id` and `Client Secret`.
 
- Client Id and Cluster Id can be retrieved by clicking on the _View_ link on the client in the _API_-Tab.
+`Client Id` and `Cluster Id` can be retrieved by clicking on **View** on the client in the **API** tab.
 
 
 ![cluster-details-created-client-view](./img/cluster-details-created-client-view.png)
 
-The Client Secret can be retrieved from the downloaded connection file:
+The `Client Secret` can be retrieved from the downloaded connection file:
 
 
 ```bash
 grep SECRET  ~/Downloads/CamundaCloudMgmtAPI-Client-test-client.txt
 export ZEEBE_CLIENT_SECRET='zbzsZI_6UnCsH_CIo0lNUN8qGyvLJr9VrH77ewNm8Oq3elvhPvV7g.QmJGydzOLo' 
 ```
 
-Click Deploy to **deploy** the workflow. Use the Play button from the navigation to **start a new instance**.
+Click **Deploy** to deploy the workflow. Use **Play** from the navigation to start a new instance.
 
 </TabItem>
 </Tabs>

docs/guides/getting-started/implement-decision-gateway.md

@@ -6,15 +6,15 @@ title: Implement a decision gateway
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
-In [the last section](./implement-service-task.md) we connected a worker that will return a JSON object as a result, which is used to decide which path to take in the workflow. Now, we can use the JSON object to route your process by filling in the condition expression on the two sequence flows after the XOR gateway.
+In [the last section](./implement-service-task.md) we connected a worker that will return a JSON object, which is used to decide which path to take in the workflow. Now, we can use the JSON object to route your process by filling in the condition expression on the two sequence flows after the XOR gateway.
 
-Use the following expression for the "Pong" sequence flow:
+Use the following conditional expression for the "Pong" sequence flow:
 
 ```bash
 =return="Pong"
 ```
 
-And for the Else Sequence flow:
+And for the else sequence flow:
 
 ```bash
 =return!="Pong"