[DOCUMENTATION] Update terms in documentation #448
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/user/terms.rst
Outdated
| A service in Prometheus is a group of related Projects and are assigned to a | ||
| specific shard | ||
| A service in Prometheus is a group of related Projects and Rules and are the | ||
| main top-level object. |
There was a problem hiding this comment.
Could we rephrase this sentence? It is a little bit difficult to understand.
There was a problem hiding this comment.
What would you recommend then?
There was a problem hiding this comment.
What would you recommend then?
I am not sure. Maybe this?
"A Service in Prometheus is a group of related Projects and Rules. Those three are the
main top-level objects."
Are there other top-level objects that are not considered "main"?
There was a problem hiding this comment.
I realized I need to fix this anyways, because service is a Promgen concept and not Prometheus.
A service in Promgen is a group of related Projects and Rules.
Service is typically the top-level object in Promgen.
vincent-olivert-riera
previously approved these changes
Nov 6, 2023
Some of these terms have not been updated in a while and need to be updated to show the current relationship between them.
vincent-olivert-riera
approved these changes
Nov 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some of these terms have not been updated in a while and need to be updated to show the current relationship between them.