fix(operator): Improve API documentation for schema version #13122
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
periklis
approved these changes
Jun 4, 2024
r2d2rnd
reviewed
Jun 6, 2024
| // EffectiveDate contains a date in YYYY-MM-DD format which is interpreted in the UTC time zone. | ||
| // | ||
| // The configuration always needs at least one schema that is currently valid. This means that when creating a new | ||
| // LokiStack it is recommended to add a schema with the latest available version and an effective date of "yesterday". |
There was a problem hiding this comment.
@xperimental perhaps instead of
LokiStack it is recommended to add a schema with the latest available version and an effective date of "yesterday". by
LokiStack it is recommended to add a schema with the latest available version and it should have an effective date of "yesterday".?
For being clear that the "recommended" is only for the schema version, but for the effective date, it should/must from yesterday for new installations
This was referenced Jun 10, 2024
This was referenced Jul 3, 2024
Closed
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.
What this PR does / why we need it:
This PR aims to improve the explanation of the schema version fields.
Which issue(s) this PR fixes:
Fixes LOG-5549
Checklist
CONTRIBUTING.mdguide (required)