temporalio/cli

Create an index of environment variables for the docs site

Open

#697 opened on Oct 21, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Go (96 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (370 stars)
PR merge metrics
 (PR metrics pending)

Description

The code generation we do for the docs site should also generate an index of environment variables similar to: https://docs.temporal.io/cli#environment-variables

Contributor guide

Research direction
Examine the existing documentation code generation in the repository to understand how the CLI documentation is built. Look for patterns similar to the environment variable index at https://docs.temporal.io/cli#environment variables. Then add a similar generation for environment variables.
Tech stack
go
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGo basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70