kairos-io/kairos

:book: Consistent name of our configuration file across docs

Closed

#2,210 opened on Feb 5, 2024

View on GitHubContributor guide
 (3 comments) (1 reaction) (0 assignees)Go (133 forks)github user discovery
documentationenhancementgood first issuehelp wanted

Repository metrics

Stars
 (1,782 stars)
PR merge metrics
 (Avg merge 2d 3h) (14 merged PRs in 30d)

Description

Despite the name of the config file not being important for Kairos, it would be nice to be consistent. This way users don't have to wonder if we are talking about the config file or some other file.

This was originally pointed out by a user in our matrix channel, thanks!

Contributor guide

Research direction
Identify all documentation files that reference the configuration file and ensure a consistent name is used throughout.
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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90