Skip to content

docs: merging configuration documents#2948

Merged
andynog merged 1 commit intomainfrom
andy/2769-merge-config-docs
May 1, 2024
Merged

docs: merging configuration documents#2948
andynog merged 1 commit intomainfrom
andy/2769-merge-config-docs

Conversation

@andynog
Copy link
Collaborator

@andynog andynog commented Apr 30, 2024

closes #2769

merging configuration documents


PR checklist

  • Tests written/updated
  • Changelog entry added in .changelog (we use unclog to manage our changelog)
  • Updated relevant documentation (docs/ or spec/) and code comments
  • Title follows the Conventional Commits spec

@andynog andynog added documentation Improvements or additions to documentation config hygiene Any work relating to code legibility/hygiene to make it easier to read labels Apr 30, 2024
@andynog andynog added this to the 2024-Q2 milestone Apr 30, 2024
@andynog andynog self-assigned this Apr 30, 2024
@andynog andynog requested a review from a team as a code owner April 30, 2024 14:11
@andynog andynog requested a review from a team April 30, 2024 14:11
Copy link
Collaborator

@melekes melekes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

## Options
Some of the parameters can be overridden by command-line flags.

The default configuration file created by `cometbft init` has all
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you compare the text here with the new one in the CometBFT Configuration Manual? Is there anything in this text worth including there? Are the hunks toward the end of the PR doing this?

Recovering nodes that "forget" the actions taken before crashing are faulty
nodes that are likely to present Byzantine behavior (e.g., double signing).

## Consensus timeouts
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This document is structured to contain the same sections as the config.toml. So by adding this section, we are splitting the consensus section, which no longer reflects the config.toml structure.

I suggest you remove this section marker, and move the sentence starting with "For a more detailed explanation" to each of the timeout fields.

Comment on lines +1740 to +1741


Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

?

|:--------------------|:--------------------------|
| **Possible values** | Prometheus namespace name |

## Consensus timeouts explained
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Consensus timeouts explained
# Consensus timeouts explained

@andynog andynog added this pull request to the merge queue May 1, 2024
Merged via the queue into main with commit 88c527b May 1, 2024
@andynog andynog deleted the andy/2769-merge-config-docs branch May 1, 2024 12:40
mergify bot pushed a commit that referenced this pull request May 1, 2024
closes #2769

merging configuration documents

---

#### PR checklist

- [ ] Tests written/updated
- [X] Changelog entry added in `.changelog` (we use
[unclog](https://github.com/informalsystems/unclog) to manage our
changelog)
- [X] Updated relevant documentation (`docs/` or `spec/`) and code
comments
- [X] Title follows the [Conventional
Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec

(cherry picked from commit 88c527b)

# Conflicts:
#	docs/explanation/core/configuration.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

config documentation Improvements or additions to documentation hygiene Any work relating to code legibility/hygiene to make it easier to read

Projects

No open projects
Status: Done

Development

Successfully merging this pull request may close these issues.

docs: merge explanation/core/configuration.mdwith introduced reference/config/ documentation

3 participants