Camunda 8 Documentation, including all components and features
Home Page: https://docs.camunda.io/
License: Other
This repository contains the Camunda 8 documentation, which can be found at https://docs.camunda.io/.
Did you know Camunda Engineers are the primary documentation authors?
Documentation strategy and infrastructure is owned by the Developer Experience team at Camunda.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
With camunda/camunda#5770, if processing is paused, that state is persisted on disk. So the state of the stream processor will be paused even after a restart. Hence after the upgrade, resumeProcessing must be called.
The current user guide for Operate does not accurately reflect the main usecases users can complete with the product.
Also, it does not provide a structure that we can build upon for the future.
ACs:
Documentation currently missing.
Recommendation: describe both Zeebe Desktop Modeler and Cloud Modeler. Cloud Modeler will also be referenced in the Cloud Console section.
Description
We've added a new experimental configuration section in Zeebe for incubating features, or dangerous features. This gives power users further options to customize Zeebe to their needs, and lets us test new features, while also freeing us from long term support of these: anything under the experimental section is subject to be dropped or to change in the future.
We should document this explicitly, and also document the flags that are currently listed there.
P.S.: let me know if this is the wrong place for these kind of issues 🙂
Proposal for a process:
Introduce technical components of Camunda Cloud Platform, route to Getting Started Guide (GSG), and provide a short explanation for developers.
Zeebe's doc has a description on combining properties of a variable into another variable, but it does not describe the more dynamic appendTo() function. At the time of writing, this is an extension function in Zeebe. It is documented in Java doc in VariableMappingTransformer.java#L22-L65, and a usage example is provided by a user that needed this feature in camunda/camunda#297 (comment).
Our documentation should contain a description and usage example of this functionality.
migrate Zeebe documentation to this repository
Description
We're currently working on automating the Zeebe upgrade procedure for Camunda Cloud. Based on our results, we can then come up with a more streamlined solution for on-prem users, and after that we should update the upgrade guide to describe it.
As we're reworking the upgrade procedure to streamline, we've updated our upgrade guide to exclude the post 0.24.4 upgrade procedure in order to avoid confusion (camunda/camunda#5779)
The goal of this issue is to keep what's currently published in sync with what's here, and we will write the new upgrade guide here first in a separate issue once the solution is available.
After migration the page Zeebe -> Operations -> Disk Space is missing.
Overview will most likely contain the following sections:
Create a brief description of each.
The Operate User guide has not been updated with the features from recent releases. In this issue we should make minimal updates to the existing user guide to reflect the current feature set. It is not about restructuring the content or adding more pages.
AC:
Examples:
Document changes of camunda/camunda#5651
See: https://v2.docusaurus.io/docs/search
Used service: https://docsearch.algolia.com/
Depends on
Description
We will work on an offline backup solution for Camunda Cloud centered around the upgrade procedure. If at all possible once a solution is fixed, let's evaluate the pros and cons of documenting it for on-prem users.
We'll probably need help from the Cloud SRE team 🙂
Technically versioning works as described here: https://v2.docusaurus.io/docs/versioning
Currently we do not make use of versioning in the docs. Starting with version 0.26 I suggest to version the docs including Product Manuals and Reference.
JDI
Menu bar responsive issue. Menu bar does not fit across top of page. Need to adjust when hamburger menu appears.
Description
We removed the admin endpoint documentation from the upgrade guide, primarily to avoid confusing as we're working the way Zeebe can be upgraded. However, it's still useful to have this documented, and we should documented it separately (which can then be linked back in the upgrade guide).
Ideally, please document each endpoint, expected request format, expected response format, etc. Something similar (but not necessarily as thorough) as https://docs.github.com/en/free-pro-team@latest/rest/reference/actions.
Phase 1: quick wins
ACs:
Samples will be out of scope release 0.26
This is the list of known defects after migration of the Zeebe documentation:
https://github.com/zeebe-io/zeebe/tree/{{commit}}/exporters/elasticsearch-exporter -> https://github.com/zeebe-io/zeebe/tree/develop/exporters/elasticsearch-exporter); this might need to be reconsidered when the versioning strategy is finalized.{{#include ../../../dist/src/main/config/application.yaml}}) have been removed , unfortunately. I did not find a ready alternative. The originals are still in the files as html commentsRelated prod issues:
Operate https://jira.camunda.com/browse/OPE-962
Tasklist https://github.com/zeebe-io/zeebe-tasklist/issues/357
On January 12 we will release v0.26. On that date (at the latest), we want to release this version of the docs and make it the sole documentation site for all Camunda Cloud Platform modules
ACs:
AC:
ACs:
Camunda Cloud has of course already been described as Cloud First by his nature. Here are the sections that in my opinion should be adapted:
| Page | Comment | Recommendation |
|---|---|---|
| Cloud Console Overview | Current description should be part of the overall introduction. On this page I see just an overview of what can be done in Camunda Cloud Console | @akeller move to introduction, @urbanisierung rewrite |
| Available Plans | is this something that should be on top level? | From my pov we can leave the pages as they are for now but I think in a target picture we need a better place for this description. @akeller @meyerdan wdyt? -Daniel agrees |
Proposal for new structure:
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.