Add markers to docs for checklist #845
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
Signed-off-by: cs-308-2023 <[email protected]>
✅ Deploy Preview for romantic-neumann-1959d7 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
yurishkuro
reviewed
Feb 14, 2025
RELEASE.md
Outdated
| @@ -1,5 +1,7 @@ | |||
| # Release instructions | |||
|
|
|||
| <!-- BEGIN_DOC --> | |||
There was a problem hiding this comment.
I would call it begin checklist
| @@ -1,5 +1,7 @@ | |||
| # Release instructions | |||
|
|
|||
| <!-- BEGIN_DOC --> | |||
|
|
|||
| Each Jaeger version is documented in a separate directory e.g. [content/docs/1.8/](./content/docs/1.8/). A special directory [content/docs/next-release/](./content/docs/next-release/) is reserved for the changes to be published as the next version. If you are adding documentation for features that are not yet released in the main Jaeger repository, add your changes to the `next-release` directory. If you're adding documentation for already released features, you may need to make the same change twice, i.e. in the most recent release (e.g. `1.8`) and in the `next-release` directories. | |||
|
|
|||
| Jaeger v2 next-release documentation is in the `next-release-v2` directory. | |||
There was a problem hiding this comment.
Shouldn't the marker be after this line? The previous ones are not a checklist
There was a problem hiding this comment.
I thought to include these just to provide some more info to the user.
Anyways, resolved now.
Signed-off-by: cs-308-2023 <[email protected]>
Signed-off-by: cs-308-2023 <[email protected]>
yurishkuro
approved these changes
Feb 14, 2025
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.
Which problem is this PR solving?
Description of the changes
How was this change tested?
Checklist
jaeger:make lint testjaeger-ui:npm run lintandnpm run test