Copy documentation over from kuttl.dev repo to kuttl
#490
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
porridge
force-pushed
the
include-docs
branch
from
05fc8ff
to
120849d
Compare
These additionally contain the changes from kudobuilder/kuttl.dev@e1979f4 which document a feature already merged in kuttl `main`. Signed-off-by: Marcin Owsiany <porridge@redhat.com>
Signed-off-by: Marcin Owsiany <porridge@redhat.com>
Signed-off-by: Marcin Owsiany <porridge@redhat.com>
GitHub automatically generates a ToC that seems to be hidden by default, but is accessible using the "dotted hamburger" icon in upper right-hand corner. See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#headings Ideally GitHub would provide a way to have an in-line auto-generated ToC or at some point we can investigate ways to have it semi-automatically generated. But for now having docs with this slightly hidden ToC is better than not having them. Signed-off-by: Marcin Owsiany <porridge@redhat.com>
Signed-off-by: Marcin Owsiany <porridge@redhat.com>
Signed-off-by: Marcin Owsiany <porridge@redhat.com>
See PR kudobuilder#488. Signed-off-by: Marcin Owsiany <porridge@redhat.com>
porridge
force-pushed
the
include-docs
branch
from
120849d
to
c97a2fd
Compare
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:
A an almost verbatim copy of the docs in the kuttl.dev repository
masterbranch, plus:kudobuilder/kuttl.dev@e1979f4
which document a feature already merged in kuttl
main.The first commit is an exact copy of the above files. Additional commits are for minor styling changes needed to adapt to GitHub markdown flavor. This is the basic set of changes necessary. I hope additional improvements to restructure the docs and bring them up to date with the actual code will come later.
Why we need it:
The primary motivation is fixing the docs vs binary versioning conundrum: it was never clear to me whether the documentation on the kutt.dev website should correspond to the
kuttlcode inmainor to the last released version (there are advantages and disadvantages to both approaches).This way we can store docs close to the same version of code they correspond to - the docs on
mainshould always match the code onmain. At the same time, the docs directory at a release-versioned URL will naturally correspond to the given release.Arguably, this commit should also modify the PR template checklist to mention that docs should be updated together with source.
Legacy docs
As for the docs still on kuttl.dev, I think we should replace them with a redirect to the
docsdirectory in this repo to prevent confusion, as soon as we revive the website deployment pipeline. The landing page on kuttl.dev can of course stay mostly as is.