DOCS-437 #141
Merged
DOCS-437 #141
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
✅ Deploy Preview for pedantic-goldberg-f76ec1 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
hasancelik
suggested changes
Nov 8, 2023
There was a problem hiding this comment.
Thanks for the change @rebekah-lawrence
Could you update support section also with required information?
https://docs.hazelcast.com/hazelcast/latest/getting-started/support#community-support
docs/modules/ROOT/pages/index.adoc
Outdated
|
|
||
| {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: |
There was a problem hiding this comment.
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: |
Removed extra space and added information on Community support
Serdaro
reviewed
Nov 28, 2023
|
|
||
| {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: | ||
|
|
There was a problem hiding this comment.
@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.
There was a problem hiding this comment.
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?
hasancelik
suggested changes
Jan 17, 2024
| * https://github.com/hazelcast/hazelcast[Hazelcast GitHub^] (for reporting issues through our GitHub repository) | ||
| * https://slack.hazelcast.com/[Hazelcast Community Slack^] | ||
| * https://groups.google.com/forum/#!forum/hazelcast[Mail Group^] | ||
| * http://www.stackoverflow.com/[StackOverflow^] | ||
|
|
There was a problem hiding this comment.
Could you add a customer support section here as well?
https://docs.hazelcast.com/hazelcast/5.3/getting-started/support#customer-support
docs/modules/ROOT/pages/index.adoc
Outdated
| For support, find us in the https://slack.hazelcast.com/[Hazelcast Community Slack^]. | ||
| Community support is for every Hazelcast user. You can use the following channels to get community support: | ||
|
|
||
| * https://github.com/hazelcast/hazelcast[Hazelcast GitHub^] (for reporting issues through our GitHub repository) |
There was a problem hiding this comment.
Suggested change
| * https://github.com/hazelcast/hazelcast[Hazelcast GitHub^] (for reporting issues through our GitHub repository) | |
| * https://github.com/hazelcast/hazelcast-platform-operator[Platform Operator GitHub^] (for reporting issues through our GitHub repository) |
docs/modules/ROOT/pages/index.adoc
Outdated
Comment on lines
31
to
32
| * https://groups.google.com/forum/#!forum/hazelcast[Mail Group^] | ||
| * http://www.stackoverflow.com/[StackOverflow^] |
There was a problem hiding this comment.
I think we can remove these two, because they are not very active 🙂
Suggested change
| * https://groups.google.com/forum/#!forum/hazelcast[Mail Group^] | |
| * http://www.stackoverflow.com/[StackOverflow^] |
hasancelik
approved these changes
Feb 13, 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.
Rewrote the Overview to explain that Platform Operator documentation is aimed at dev/devops with intermediate K8 knowledge.