Update Documentation #896
Merged
Update Documentation #896
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
The contents of this tutorial are essentially covered by the guided tour. Furthermore, this tutorial involves legacy component-cli and legacy landscaper-cli commands and would therefore require updating.
|
Skipping CI for Draft Pull Request. |
gardener-robot
added
needs/review
As the gettingstarted directory contains exclusively installation instructions, installation is a more suitable name that allows to find the instructions more intuitively. Furthermore a dedicated directory makes sense (instead of e.g. putting it in the guided tour), since this is quite important information that is referenced from several locations.
fabianburth
force-pushed
the
update-documentation
branch
from
14ea251 to
bb30626
Compare
There should only exist a single document describing the installation of the landscaper. This makes it easier to keep the documentation clean and up to date.
gardener-robot-ci-1
added
the
reviewed/ok-to-test
gardener-robot-ci-2
added
needs/ok-to-test
For large parts, the content of the tutorials has been superseded by the guided tour. Again, maintaining redundant documentation causes unnecessary overhead.
gardener-robot-ci-3
added
reviewed/ok-to-test
This documentation is unfinished and unused. Besides, most of its content is a duplicate of the guided tour.
gardener-robot-ci-2
added
reviewed/ok-to-test
Inline component descriptors were announced to be deprecated and should therefore be removed from the documentation.
gardener-robot-ci-2
added
the
reviewed/ok-to-test
gardener-robot-ci-1
added
reviewed/ok-to-test
fabianburth
force-pushed
the
update-documentation
branch
from
c042326 to
7c940c2
Compare
gardener-robot-ci-1
added
reviewed/ok-to-test
gardener-robot
added
area/documentation
gardener-robot-ci-2
added
the
reviewed/ok-to-test
gardener-robot-ci-3
removed
the
reviewed/ok-to-test
A previous commit removed the entire docs/tutorial folder since the content was deemed to be a duplicate of the guided tour. But the resources in this directory are used by some integration tests.
gardener-robot-ci-3
added
reviewed/ok-to-test
fabianburth
force-pushed
the
update-documentation
branch
from
e5d589d to
2ee75d5
Compare
gardener-robot-ci-3
added
reviewed/ok-to-test
gardener-robot-ci-1
added
reviewed/ok-to-test
gardener-robot-ci-3
added
reviewed/ok-to-test
gardener-robot-ci-3
added
reviewed/ok-to-test
|
@Diaphteiros, @achimweigel You have pull request review open invite, please check |
achimweigel
approved these changes
Nov 23, 2023
gardener-robot
added
the
status/closed
guewa
pushed a commit
that referenced
this pull request
Dec 5, 2023
* fix faulty example * Remove manifest-deployer-tutorial The contents of this tutorial are essentially covered by the guided tour. Furthermore, this tutorial involves legacy component-cli and legacy landscaper-cli commands and would therefore require updating. * Move landscaper installation instructions As the gettingstarted directory contains exclusively installation instructions, installation is a more suitable name that allows to find the instructions more intuitively. Furthermore a dedicated directory makes sense (instead of e.g. putting it in the guided tour), since this is quite important information that is referenced from several locations. * Unify the installation instructions There should only exist a single document describing the installation of the landscaper. This makes it easier to keep the documentation clean and up to date. * Remove tutorials For large parts, the content of the tutorials has been superseded by the guided tour. Again, maintaining redundant documentation causes unnecessary overhead. * Remove unfinished and unused documentation This documentation is unfinished and unused. Besides, most of its content is a duplicate of the guided tour. * Remove inline component descriptor from installation scaffold Inline component descriptors were announced to be deprecated and should therefore be removed from the documentation. * Update component descriptor glossary entry * (run-int-tests) * Move tutorial resources to corresponding integration tests A previous commit removed the entire docs/tutorial folder since the content was deemed to be a duplicate of the guided tour. But the resources in this directory are used by some integration tests. * Adjust further references to tutorial resources (run-int-tests) * (run-int-tests) * (run-int-tests) * (run-int-tests)
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.
How to categorize this PR?
/area documentation
/kind cleanup
/priority 3
What this PR does / why we need it:
This PR is motivated by the deprecation of the component-cli and is essentially a follow-up to the PRs integrating the ocm-lib into the landscaper to perspectively replace the component-cli (#837, #844) and the adjustment of the templating to also enable component descriptors of schema version v3alpha1 (#863).
This PR cleans up the documentation by updating or removing outdated sections and replacing the legacy component-cli commands with ocm-cli commands.
Thereby, it prepares the removal of the component-cli from the landscaper.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
This PR deletes the entire Tutorials section with all its content. It appears to me, that the content is generally the same as the content of the Guided Tour.
Release note: