Skip to content

DOC-546: include install & get started info from readme #1783

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

amandalindsay
Copy link
Contributor

For https://hazelcast.atlassian.net/browse/DOC-546 - include get started & installation instructions, basic config and usage. This is existing info in the Python client readme and the 'readthedocs' site which has been scrubbed.

Copy link

netlify bot commented Jul 24, 2025

Deploy Preview for hardcore-allen-f5257d ready!

Name Link
🔨 Latest commit e91b59c
🔍 Latest deploy log https://app.netlify.com/projects/hardcore-allen-f5257d/deploys/688782517dc051000761cef4
😎 Deploy Preview https://deploy-preview-1783--hardcore-allen-f5257d.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@amandalindsay amandalindsay requested a review from yuce July 24, 2025 12:48
Copy link
Contributor

@yuce yuce left a comment

Choose a reason for hiding this comment

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

Thanks for the PR, here are a few ideas...

Comment on lines 64 to 66
// Author's question: Yuce - to aid cutting/pasting, are we better to separate these commands
// into discreet chunks which will allow developers to cut and paste without the comments?
// Or is this section OK as it is?
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it would be OK to split it into chunks.

@amandalindsay amandalindsay marked this pull request as ready for review July 28, 2025 14:10
@amandalindsay amandalindsay requested a review from a team as a code owner July 28, 2025 14:10
Copy link
Contributor

@yuce yuce left a comment

Choose a reason for hiding this comment

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

Thanks, looks good!

@oliverhowell oliverhowell changed the title Doc 546: include install & get started info from readme DOC-546: include install & get started info from readme Aug 15, 2025
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.

2 participants