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

Configuration file links broken and unversioned #3744

Open
falko opened this issue Apr 30, 2024 · 1 comment
Open

Configuration file links broken and unversioned #3744

falko opened this issue Apr 30, 2024 · 1 comment
Assignees
Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed component:zeebe Issues related with Zeebe project

Comments

@falko
Copy link
Member

falko commented Apr 30, 2024

The links to the configuration files are currently broken:

- [`config/application.yaml` Standalone Broker (with embedded gateway)](https://github.com/camunda/zeebe/tree/main/zeebe/dist/src/main/config/application.yaml) - Default configuration containing only the most common configuration settings. Use this as the basis for a single broker deployment for test or development.
- [`config/broker.standalone.yaml.template` Standalone Broker (with embedded gateway)](https://github.com/camunda/zeebe/tree/main/zeebe/dist/src/main/config/broker.standalone.yaml.template) - Complete configuration template for a standalone broker with embedded gateway. Use this as the basis for a single broker deployment for test or development.
- [`config/broker.yaml.template` Broker Node (without embedded gateway)](https://github.com/camunda/zeebe/tree/main/zeebe/dist/src/main/config/broker.yaml.template) - Complete configuration template for a broker node without embedded gateway. Use this as the basis for deploying multiple broker nodes as part of a cluster.
- [`config/gateway.yaml.template`](https://github.com/camunda/zeebe/tree/main/zeebe/dist/src/main/config/gateway.yaml.template) - Complete configuration template for a standalone gateway.

While the Zeebe source code has been moved to a sub-folder the dist folder has not moved, i.e. the files are still here: https://github.com/camunda/zeebe/tree/main/dist/src/main/config

In addition, the files for older versions are available in tags, e.g. https://github.com/camunda/zeebe/tree/8.5.0/dist/src/main/config

So, the versioned docs should link to the corresponding tag or users will have surprises trying to use configuration parameters that don't exist in older versions.

Also the Camunda Docs AI does not know about the contents of these configuration files and can therefore can't answer questions like:

What does ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_ARGS_INDEX_NUMBER_OF_SHARDS?

@akeller akeller added component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed component:zeebe Issues related with Zeebe project labels Apr 30, 2024
@akeller
Copy link
Member

akeller commented May 6, 2024

@christinaausley can I have you take a look at the link component of this issue in the next two weeks? Having the right versioned links in the docs for each minor makes sense.

Regarding the Camunda Docs AI, we can split this into a separate issue on the Developer Experience repo and explore how we want to handle it. We don't ingest repos, but it might be a point to start that conversation or trial very specific files with config values (and, likely, inline docs).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed component:zeebe Issues related with Zeebe project
Projects
Status: 🏗 In Progress
Development

No branches or pull requests

3 participants