Update documentation #3687
Merged
Update documentation #3687
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
Michal-Leszczynski
added
the
documentation
tzach
reviewed
Jan 14, 2024
karol-kokoszka
approved these changes
Jan 15, 2024
|
@annastuchlik could you take a look at this PR? |
There was a problem hiding this comment.
I've only added one minor suggestion.
Another one is to add the note in a separate file in the _common folder and add it in appropriate places using the include directive, for example:
.. include:: _common/operator-reference.rst
This update is recommended but not critical.
Michal-Leszczynski
force-pushed
the
ml/update-docs
branch
from
4993baf to
0281e3a
Compare
|
The problem with using include for linking to operator docs is that there are separate pages for repair/backup and for restore. So for now I will keep the links directly in the code, so that they don't get confused, but it can be changed later on. |
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.
This PR fixes a bunch of documentation related issues.
Fixes #3684
Fixes #3681
Fixes #3661
Fixes #3663