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

DOC-379 Migrate PO tutorials #298

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

DOC-379 Migrate PO tutorials #298

wants to merge 16 commits into from

Conversation

amandalindsay
Copy link
Contributor

Migration of Platform Operator tutorials from the Tutorials repo into the main docs repo.
Applied a new template/structure to the tutorials.

Copy link

netlify bot commented Feb 17, 2025

Deploy Preview for pedantic-goldberg-f76ec1 ready!

Name Link
🔨 Latest commit 5f1930f
🔍 Latest deploy log https://app.netlify.com/sites/pedantic-goldberg-f76ec1/deploys/67b7432a4b479800088b2f6e
😎 Deploy Preview https://deploy-preview-298--pedantic-goldberg-f76ec1.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 site configuration.

@amandalindsay amandalindsay marked this pull request as ready for review February 18, 2025 14:32
@amandalindsay amandalindsay requested a review from a team as a code owner February 18, 2025 14:32
Copy link
Contributor

@Rob-Hazelcast Rob-Hazelcast left a comment

Choose a reason for hiding this comment

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

Generally looks good. I've not reviewed all the tutorials, but I've reviewed a couple of them and highlighted some minor things that apply throughout. Putting the tutorials under "get started" and linking to them from the relevant sections seems reasonable here, but we won't be able to do that for Platform (there'd be too many). Maybe at some point we can introduce some structure to the Operator TOC and revisit this.


=== Connect Hazelcast Clients to the Cluster

To access all sample clients, clone the following repository:
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we have a plan for migrating this stuff to the code samples repo?

Copy link
Contributor Author

@amandalindsay amandalindsay Feb 20, 2025

Choose a reason for hiding this comment

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

Not that I'm currently aware of, and not as part of this PR. One for @oliverhowell

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 we should do it as part of this exercise - raise the corresponding code-samples PR and update the refs

@oliverhowell oliverhowell changed the title Doc 379 tutorials DOC-379 Migrate PO tutorials Feb 20, 2025
Copy link
Contributor

@oliverhowell oliverhowell left a comment

Choose a reason for hiding this comment

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

Good progress but I would like to deal with some of the gnarly issues in this cycle e.g. moving code samples into the code-samples repo and updating refs, and removing unused page variables etc.

====

+
The sample code for this tutorial is in the link:{github-directory}/tree/master/jet-pipeline/src/main/java/org/example/run[`jet-pipeline/src/main/java/org/example/run/`] directory:
Copy link
Contributor

Choose a reason for hiding this comment

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

Lines like this will rely on the github-directory variable at top of page - I think we should move these types of code includes into hazelcast-code-samples and update the refs...


=== Connect Hazelcast Clients to the Cluster

To access all sample clients, clone the following repository:
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 we should do it as part of this exercise - raise the corresponding code-samples PR and update the refs

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.

3 participants