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

Reformat docs and add a new CLI option #7566

Merged
merged 8 commits into from
Oct 10, 2024
Merged

Reformat docs and add a new CLI option #7566

merged 8 commits into from
Oct 10, 2024

Conversation

rubo
Copy link
Contributor

@rubo rubo commented Oct 7, 2024

Changes

  • Updated the configuration and metrics docs to provide a link for each configuration/metrics option
  • Added "CLI | Environment variable | Configuration file" section to each configuration option
  • Revised links
  • Added DB size source directory CLI option for DB size generator

Types of changes

What types of changes does your code introduce?

  • Bugfix (a non-breaking change that fixes an issue)
  • New feature (a non-breaking change that adds functionality)
  • Breaking change (a change that causes existing functionality not to work as expected)
  • Optimization
  • Refactoring
  • Documentation update
  • Build-related changes
  • Other: Description

Testing

Requires testing

  • Yes
  • No

Documentation

Requires documentation update

  • Yes
  • No

Preview here

@rubo rubo added the docs label Oct 7, 2024
@rubo rubo marked this pull request as ready for review October 7, 2024 17:21
@rubo rubo changed the title Reformat configuration and metrics docs Reformat docs and add a new CLI option Oct 9, 2024
@rubo rubo requested a review from a team as a code owner October 9, 2024 14:23
@rubo rubo merged commit e6d7733 into master Oct 10, 2024
73 checks passed
@rubo rubo deleted the feature/doc-md-reformat branch October 10, 2024 14:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants