temporalio / temporalio/temporal

Document configuration (development.yaml, dynamicconfig)

Open
#2,891 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Go
Stars
23.2k
Forks
1.9k
Avg merge
2d 8h
Merged PRs (30d)
228

Description

Is your feature request related to a problem? Please describe.
There is almost no documentation on what the development.yaml file is, how it relates to dynamicconfig, etc. This is the closest thing: https://docs.temporal.io/server/configuration, and it is severely lacking a high-level explanation.

Describe the solution you'd like
A page dedicated to what this file is, how it relates to dynamicconfig, where is this file expected to be in a production deployment or docker-compose setup, etc.

Describe alternatives you've considered
N/A

Additional context
I am running through my local and production setup for the first time (I am a new Temporal user).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing Temporal server configuration page and inspect the development.yaml and dynamicconfig references in the repository. Done means a dedicated page explains their relationship and documents where development.yaml belongs in production deployments and docker-compose setups.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose
Domain
devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.