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.

Sign up for GitHub

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

DOCS-437 #141

Merged
merged 3 commits into from
Feb 14, 2024
Merged

DOCS-437 #141

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3970937
DOCS-437
rebekah-lawrence Oct 26, 2023
cbd5cae
Updated from review
rebekah-lawrence Nov 8, 2023
95a6c5c
Updated from comments
rebekah-lawrence Feb 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/modules/ROOT/pages/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
= Hazelcast Platform Operator
:!page-pagination:
:description: Hazelcast Platform Operator automates common management tasks such as configuring, creating, scaling, and recovering Hazelcast clusters on Kubernetes and Red Hat OpenShift. By taking care of manual deployment and life-cycle management, Hazelcast Platform Operator makes it simpler to work with Hazelcast clusters.
:description: By eliminating the need for manual deployment and life-cycle management, Hazelcast Platform Operator simplifies working with Hazelcast clusters on Kubernetes and Red Hat OpenShift.

{description}

Hazelcast Platform Operator allows your development and DevOps teams to automate common management tasks for your Hazelcast clusters on Kubernetes and Red Hat OpenShift. For example, you can use Hazelcast Platform Operator to automate the following tasks:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Hazelcast Platform Operator allows your development and DevOps teams to automate common management tasks for your Hazelcast clusters on Kubernetes and Red Hat OpenShift. For example, you can use Hazelcast Platform Operator to automate the following tasks:
Hazelcast Platform Operator allows your development and DevOps teams to automate common management tasks for your Hazelcast clusters on Kubernetes and Red Hat OpenShift. For example, you can use Hazelcast Platform Operator to automate the following tasks:


Copy link
Contributor

Choose a reason for hiding this comment

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

@rebekah-lawrence , the last couple of words of the description text and the sentence after it are the same. The flow or reading made me feel a duplication since they are very close to each other.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yup, here was my logic:

  • The first sentence was already too long (24 words), so I didn't want to add something like ", such as the following"
  • They are a duplication as one is introducing examples of the other; it is difficult to avoid the duplication and retain the sense of what is being introduced
  • People scan, so the duplication also helps to ensure they do digest what is being said. Also, I'd rather use the same words than paraphrase for variety so that people don't have to think while they scan

Any suggestions to improve it?

* Configuration
* Creation
* Scaling
* Recovery

This documentation assumes an intermediate knowledge of Kubernetes.

////
Content to consider for this page:

Expand Down
Loading