OTA-560: Modernize README.md to be user-centered #869
Merged
Conversation
This file contains hidden or 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
openshift-ci
bot
added
the
do-not-merge/work-in-progress
openshift-ci
bot
added
the
approved
Member
Author
petr-muller
force-pushed
the
ota-560-user-centered-readme
branch
from
aa7a073 to
de36132
Compare
wking
reviewed
Nov 30, 2022
wking
reviewed
Nov 30, 2022
wking
reviewed
Nov 30, 2022
wking
reviewed
Nov 30, 2022
wking
reviewed
Nov 30, 2022
wking
reviewed
Nov 30, 2022
wking
reviewed
Nov 30, 2022
obrown1205
reviewed
Dec 1, 2022
petr-muller
force-pushed
the
ota-560-user-centered-readme
branch
from
de36132 to
bf6cc77
Compare
wking
reviewed
Dec 5, 2022
wking
reviewed
Dec 5, 2022
wking
reviewed
Dec 5, 2022
wking
reviewed
Dec 5, 2022
petr-muller
force-pushed
the
ota-560-user-centered-readme
branch
from
bf6cc77 to
59e0826
Compare
But there are way more CVO consumers than there are CVO devs. We should aim the README at "what does the CVO do for my clusters?"``
petr-muller
force-pushed
the
ota-560-user-centered-readme
branch
from
59e0826 to
4d4d4b4
Compare
petr-muller
changed the title
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
Member
Author
|
4d4d4b4 contains all fixes for the formatting artifacts pointed out by @wking I have moved this PR from WIP, @LalatenduMohanty pointed out that it's better to submit the "move developer-oriented content to new location" part of OTA-560 as a separate PR. |
Contributor
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: petr-muller, wking The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
CVO-specific user-targeting content will always partially overlap with other
documentation, like OCP docs about upgrades, the
dev-guidein the openshift/enhancementrepository and perhaps other locations. Ideally we want avoid duplicating other
content here as much as possible: only cover the basics or really CVO-specific
content in this repository, and link elsewhere when needed.
The goals of the README are the following:
about development, testing and contributing
This PR only brings the user-facing content. The developer-facing content is moved/updated in a separate #871