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

[API-2108]UCD Documentation #10

Merged
merged 63 commits into from
Apr 16, 2024
Merged

[API-2108]UCD Documentation #10

merged 63 commits into from
Apr 16, 2024

Conversation

emreyigit
Copy link
Contributor

@emreyigit emreyigit commented Dec 21, 2023

Documentation of python user code deployment and yaml job definition.

Note: This docs will be valid after UCD is released in Viridian. Also the base image name is not defined yet officially. It should be fixed after it is created.

Copy link

netlify bot commented Dec 21, 2023

Deploy Preview for eclectic-sawine-19fcf1 ready!

Name Link
🔨 Latest commit 7b74d6c
🔍 Latest deploy log https://app.netlify.com/sites/eclectic-sawine-19fcf1/deploys/6615b2b52b87cb00080d57c1
😎 Deploy Preview https://deploy-preview-10--eclectic-sawine-19fcf1.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.

@emreyigit emreyigit changed the title UCD Documentation [API-2108]UCD Documentation Dec 21, 2023
@emreyigit emreyigit added the documentation Improvements or additions to documentation label Dec 21, 2023
@emreyigit emreyigit added this to the 5.4.0 milestone Dec 21, 2023
@emreyigit emreyigit marked this pull request as ready for review December 22, 2023 13:52
docs/modules/ROOT/pages/yaml-job-definition.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/yaml-job-definition.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/yaml-job-definition.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/yaml-job-definition.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/yaml-job-definition.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/yaml-job-definition.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/clc-job.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/yaml-job-definition.adoc Outdated Show resolved Hide resolved

The stages of a Jet job can be defined with in a yaml file without any Java code interaction. A basic streaming job consists of two or more stages. These are source, transform and sink stages. The transformation stage is optional, and a pipeline can have multiple transformation steps. In order to define these stages for your job, you can benefit from a yaml definition without any coding effort.

NOTE: This feature is only available if your cluster is running on Viridian.
Copy link
Contributor

Choose a reason for hiding this comment

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

Not keen on documenting Viridian within Platform, but this is a current issue across the docs.

We maybe ought to consider a single source with partials across the docs - but this would be a much bigger update to achieve.

For now, I suggest we retain this Viridian-specific information in the Platform docs for this update and address the issue as part of the larger docs improvements.

(sorry, this is a note for @hazelcast/documentation and can be ignored for this review)

docs/modules/ROOT/pages/yaml-job-definition.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/yaml-job-definition.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/yaml-job-definition.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/yaml-job-definition.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/yaml-job-definition.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/yaml-job-definition.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/yaml-job-definition.adoc Outdated Show resolved Hide resolved
Copy link
Collaborator

@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.

Just two trivial ideas, will continue to review.

docs/modules/ROOT/pages/yaml-job-definition.adoc Outdated Show resolved Hide resolved
@@ -0,0 +1,542 @@
= YAML Job Definition

The stages of a Jet job can be defined with in a yaml file without any Java code interaction. A basic streaming job consists of two or more stages. These are source, transform and sink stages. The transformation stage is optional, and a pipeline can have multiple transformation steps. In order to define these stages for your job, you can benefit from a yaml definition without any coding effort.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The stages of a Jet job can be defined with in a yaml file without any Java code interaction. A basic streaming job consists of two or more stages. These are source, transform and sink stages. The transformation stage is optional, and a pipeline can have multiple transformation steps. In order to define these stages for your job, you can benefit from a yaml definition without any coding effort.
The stages of a Jet pipeline can be defined with in a yaml file without any Java code interaction. A basic streaming job consists of two or more stages. These are source, transform and sink stages. The transformation stage is optional, and a pipeline can have multiple transformation steps. In order to define these stages for your job, you can benefit from a yaml definition without any coding effort.

emreyigit and others added 12 commits February 14, 2024 17:15
emreyigit and others added 18 commits February 14, 2024 17:39
Copy link
Contributor

@rebekah-lawrence rebekah-lawrence left a comment

Choose a reason for hiding this comment

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

LGTM

@yuce
Copy link
Collaborator

yuce commented Feb 16, 2024

Let's please not merge this one until the following PR is reviewed and merged:
https://github.com/hazelcast/clc/pull/92

@emreyigit emreyigit merged commit 9c2ce64 into hazelcast:main Apr 16, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants