Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for v1.2 #609

Merged
merged 20 commits into from
Jul 11, 2019
Merged

Update docs for v1.2 #609

merged 20 commits into from
Jul 11, 2019

Conversation

FxKu
Copy link
Member

@FxKu FxKu commented Jul 6, 2019

  • Make README more compact and move parts to index.md
  • Update quickstart with kind, OLM
  • Remove paragraphs from dev guide which are redundant to quickstart
  • Move user-facing clusterrole section to admin docs
  • Add standby section and mark optional parameters in cluster_manifest.md
  • Have a heading and intro sentence in each guide
  • Fix some heading hierarchies and try to only have 80-character-long lines


The Postgres [operator](https://coreos.com/blog/introducing-operators.html)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where did this go?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Moved" to index.md (concepts). It already contained the same description as the README except for the 4th bullet point.

@@ -51,26 +36,16 @@ The Postgres Operator made it to the [Google Summer of Code 2019](https://summer
* [cluster manifest reference](docs/reference/cluster_manifest.md)
* [command-line options and environment variables](docs/reference/command_line_and_environment.md)

The rest of this document is a tutorial to get you up and running locally with the operator on Minikube.

## Overview of involved entities
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where are the entities now?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to index.md as well. I thought it's a better place than the README, which is quite bloated right now.

@FxKu FxKu added this to the v1.2 milestone Jul 8, 2019
README.md Outdated Show resolved Hide resolved
docs/quickstart.md Outdated Show resolved Hide resolved
docs/reference/cluster_manifest.md Outdated Show resolved Hide resolved
docs/reference/cluster_manifest.md Outdated Show resolved Hide resolved
@FxKu FxKu mentioned this pull request Jul 10, 2019
@sdudoladov
Copy link
Member

👍

@sdudoladov
Copy link
Member

👍

@FxKu
Copy link
Member Author

FxKu commented Jul 11, 2019

👍

1 similar comment
@RafiaSabih
Copy link
Contributor

👍

@FxKu FxKu merged commit 4fc5822 into master Jul 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants