kubeflow / website

Kubeflow's public website
Creative Commons Attribution 4.0 International
145 stars 751 forks source link

Add docs for spark-operator #3767

Closed ChenYi015 closed 1 week ago

ChenYi015 commented 2 weeks ago

Add docs for kubeflow/spark-operator.

ChenYi015 commented 2 weeks ago

cc @andreyvelich @yuchaoran2011 @vara-bonthu

ChenYi015 commented 2 weeks ago

/assign @andreyvelich

ChenYi015 commented 2 weeks ago

@ChenYi015 thanks for this!

We can iterate on the wording in the future, but it's much better than having no docs!

My main requests are for consistency with the other pages:

  • Can you rename quick-start.md to getting-started.md and change the title to Getting Started
  • Can you rename API Reference to Reference
  • Can you add a What is Kubeflow Spark Operator? heading to the top of the Overview page, which very briefly introduces what it is (check the other components for inspiration)

Can you also update the link on the "Installing Kubeflow" page to point to the installation guide on the website (it currently points to the repo):

https://github.com/kubeflow/website/blob/2e451d18c8b21bfa70a7a8255306b2cd83efe609/content/en/docs/started/installing-kubeflow.md?plain=1#L121-L123

Update it to point to the "Installation" section of the getting started page.

Done.

vara-bonthu commented 1 week ago

Thanks, everyone for the review. Our initial goal is to move the docs from the Spark Operator to Kubeflow, and @ChenYi015 has done a fantastic job with that. The next steps will involve the community revisiting these docs individually to validate and reword them as necessary.

@thesuperzapper @StefanoFioravanzo @hbelmiro @vikas-saxena02 if you are happy with the current structure, then please leave your approval so that we can merge it.

@andreyvelich @yuchaoran2011

hbelmiro commented 1 week ago

@vara-bonthu if you can wait, I have a few comments, but I still didn't have time to complete the review. I plan to do it today.

ChenYi015 commented 1 week ago

@hbelmiro Thanks for the review! I had updated the docs and fixed the borken links.

ChenYi015 commented 1 week ago

@vikas-saxena02 Thanks for the review. This PR is mainly for moving docs from spark-operator to this repo. We can enrich and reword the docs lately e.g. using spark operator on other clouds.

vikas-saxena02 commented 1 week ago

@vikas-saxena02 Thanks for the review. This PR is mainly for moving docs from spark-operator to this repo. We can enrich and reword the docs lately e.g. using spark operator on other clouds.

Thanks @ChenYi015 I totally agree, I am happy with the changes so far!!

vikas-saxena02 commented 1 week ago

/approve

vikas-saxena02 commented 1 week ago

/lgtm

vikas-saxena02 commented 1 week ago

Since there hasnt been anymore comments on this since last 24 hours, I am giving it the lgtm label so that @ChenYi015 doesnt get demotivated :)

google-oss-prow[bot] commented 1 week ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andreyvelich, vara-bonthu, vikas-saxena02

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/kubeflow/website/blob/master/OWNERS)~~ [andreyvelich] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment