Closed ChenYi015 closed 1 week ago
cc @andreyvelich @yuchaoran2011 @vara-bonthu
/assign @andreyvelich
@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
togetting-started.md
and change the title toGetting Started
- Can you rename
API Reference
toReference
- Can you add a
What is Kubeflow Spark Operator?
heading to the top of theOverview
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):
Update it to point to the "Installation" section of the getting started page.
Done.
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
@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.
@hbelmiro Thanks for the review! I had updated the docs and fixed the borken links.
@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 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!!
/approve
/lgtm
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 :)
[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
Add docs for kubeflow/spark-operator.