uber / cadence-docs Goto Github PK

Some recommendation for dealing with different alerts/error/

https://cadenceworkflow.io/docs/operation-guide/troubleshooting

Where: https://cadenceworkflow.io/docs/concepts/

The deployment topology explains how all these concepts are mapped to deployable software components.

This link 404s https://cadenceworkflow.io/docs/concepts/topology/

• some of the items are no longer valid, need to remove
• some items are missing default values
• there are some new items added recently: check https://github.com/uber/cadence/blob/master/common/service/dynamicconfig/constants.go
• Add Supported Version and Deprecated Since versions for each config

So that users can easily know which configuration are available in which versions.

Do this after this PR is released: uber/cadence#4129

So that the go-docs will contain the exactly same information

https://github.com/uber/Cadence-Docs/blob/master/src/docs/01-get-started/01-server-installation.md
All the docker containers don't start because prometheus.yml should be pulled under a prometheus folder and the graphana config folder is not pulled.

https://cadenceworkflow.io/docs/concepts/search-workflows/#local-testing

this won't work in real cluster becuase there are more than 1 nodes.

So there are two steps:

1. Add the key to ElasitcSearch using CLI
2. Add the key in https://github.com/uber/cadence/blob/master/config/dynamicconfig/development_es.yaml

Clicking on the following link in the blog post https://cadenceworkflow.io/blog/2023/07/01/components-of-cadence-application-setup/. gives a 404 error (see attached screenshot)

You can follow the instructions provided here.

After uber/cadence#4241 is released.

Is it possible to make the width of the page more adaptive? @just-at-uber

Currently, https://cadenceworkflow.io/docs/operation-guide/setup/ only acknowledges the existence of (and explains) the file-based dynamic config option for Cadence. configstore Dynamic Config has been implemented and may be a preferable option for some Cadence users; however, the documentation is not advertising the fact that this option is available, or helping users to set it up.

We should update:

• https://cadenceworkflow.io/docs/operation-guide/setup/#static-configuration to show that the static configuration can be set to make Cadence use the configstore dynamic config implementation
• https://cadenceworkflow.io/docs/operation-guide/setup/#dynamic-configuration with directions for using the configstore implementation (i.e. setting, getting, updating values via the CLI)