CLOUD-820 README update to mention documentation #640
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
nastena1606
requested review from
hors,
egegunes,
inelpandzic and
pooknull
as code owners
|
|
spron-in
reviewed
Jan 18, 2024
README.md
Outdated
| @@ -23,37 +23,49 @@ Whether you need to get a simple PostgreSQL cluster up and running, need to depl | |||
| - Scheduled and manual backups | |||
| - Integrated monitoring with [Percona Monitoring and Management](https://www.percona.com/software/database-tools/percona-monitoring-and-management) | |||
|
|
|||
| # Architecture | |||
| Percona Operator is the command line tool. If you feel more comfortable with operating the Operator and database clusters via the web interface, there is [Percona Everest](https://docs.percona.com/everest/index.html) web-based database provisioning tool available for you. It automates day-to-day database management operations for you, reducing the overall administrative overhead. [Get started with Percona Everest](https://docs.percona.com/everest/quickstart-guide/quick-install.html) | |||
There was a problem hiding this comment.
Suggested change
| Percona Operator is the command line tool. If you feel more comfortable with operating the Operator and database clusters via the web interface, there is [Percona Everest](https://docs.percona.com/everest/index.html) web-based database provisioning tool available for you. It automates day-to-day database management operations for you, reducing the overall administrative overhead. [Get started with Percona Everest](https://docs.percona.com/everest/quickstart-guide/quick-install.html) | |
| Percona Operator is the command line tool. If you feel more comfortable with operating the Operator and database clusters via the web interface, there is [Percona Everest](https://docs.percona.com/everest/index.html) open-source web-based database provisioning tool available for you. It automates day-to-day database management operations for you, reducing the overall administrative overhead. [Get started with Percona Everest](https://docs.percona.com/everest/quickstart-guide/quick-install.html) |
nastena1606
force-pushed
the
CLOUD-820-Readme-updates-pg
branch
from
2cc62f0 to
fc090ff
Compare
modified: README.md
nastena1606
force-pushed
the
CLOUD-820-Readme-updates-pg
branch
from
fc090ff to
7a31c2c
Compare
hors
approved these changes
Jan 25, 2024
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.
modified: README.md
CHANGE DESCRIPTION
Problem:
READMEs across all Operators are misaligned, having different structure, content and lacking links to Documentation
Short explanation of the problem.
Update README to mention documentation
Cause:
Short explanation of the root cause of the issue if applicable.
Solution:
Added Docs links, updated READMe structure and content
Short explanation of the solution we are providing with this PR.
CHECKLIST
Jira
Needs Doc) and QA (Needs QA)?Tests
Config/Logging/Testability