-
Notifications
You must be signed in to change notification settings - Fork 13
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
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for pedantic-goldberg-f76ec1 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this 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.
docs/modules/tutorials/pages/operator-tutorial-expose-externally.adoc
Outdated
Show resolved
Hide resolved
docs/modules/tutorials/pages/operator-tutorial-expose-externally.adoc
Outdated
Show resolved
Hide resolved
docs/modules/tutorials/pages/operator-tutorial-expose-externally.adoc
Outdated
Show resolved
Hide resolved
|
||
=== Connect Hazelcast Clients to the Cluster | ||
|
||
To access all sample clients, clone the following repository: |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
docs/modules/tutorials/pages/operator-tutorial-external-backup-restore.adoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this 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.
docs/modules/tutorials/pages/operator-tutorial-jet-job-snapshot.adoc
Outdated
Show resolved
Hide resolved
==== | ||
|
||
+ | ||
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: |
There was a problem hiding this comment.
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...
docs/modules/tutorials/pages/operator-tutorial-jet-job-snapshot.adoc
Outdated
Show resolved
Hide resolved
|
||
=== Connect Hazelcast Clients to the Cluster | ||
|
||
To access all sample clients, clone the following repository: |
There was a problem hiding this comment.
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
Migration of Platform Operator tutorials from the Tutorials repo into the main docs repo.
Applied a new template/structure to the tutorials.