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

Documentation updates: usage tracking, vanilla Kubeflow and more #114

Merged
merged 1 commit into from
Mar 1, 2022

Conversation

surajkota
Copy link
Contributor

@surajkota surajkota commented Mar 1, 2022

Which issue is resolved by this Pull Request:

  • TODO item from Add telemetry component #92 regarding detailed documentation for telemetry component
  • Moved the installation instructions for vanilla Kubeflow to the vanilla directory and added cluster creation steps for easy reference on Kubeflow.org website is working on
  • Changed the name from AWS distribution of Kubeflow to Kubeflow on AWS to be consistent with website and usage tracking documentation
  • Added a section in vanilla Kubeflow readme: Exposing Kubeflow over Load Balancer to this #67 (comment) to expose deployment over LoadBalancer.

Testing

  • links are working as expected

@surajkota surajkota force-pushed the v1.3-branch branch 4 times, most recently from 88d8c6c to 788ce3a Compare March 1, 2022 21:44
@surajkota
Copy link
Contributor Author

surajkota commented Mar 1, 2022

Fixed a few broken links, please take another look

@surajkota surajkota mentioned this pull request Mar 1, 2022
12 tasks
- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) - A command line tool for interacting with AWS services.
- [eksctl](https://eksctl.io/introduction/#installation) - A command line tool for working with EKS clusters.
- [kubectl](https://kubernetes.io/docs/tasks/tools) - A command line tool for working with Kubernetes clusters.
- [yq](https://mikefarah.gitbook.io/yq) - A command line tool for YAML processing. (For Linux environments, use the [wget plain binary installation](https://mikefarah.gitbook.io/yq/#wget))
Copy link
Contributor

Choose a reason for hiding this comment

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

Link doesn’t seem to be accurate and suggests going to GitHub page for wget https://github.com/mikefarah/yq/#wget

Copy link
Contributor

@rrrkharse rrrkharse left a comment

Choose a reason for hiding this comment

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

Clicked on all the links, and tried to follow the path of a first time user as much as I could without bias of knowing the repository. The overall pathing is much improved and links work.

@ryansteakley
Copy link
Contributor

Good work :)

@surajkota surajkota merged commit abd9de9 into awslabs:v1.3-branch Mar 1, 2022
surajkota added a commit that referenced this pull request Mar 8, 2022
**Description of your changes:**
- Bring in changes from #114:
  - TODO item from #109 regarding detailed documentation for telemetry component
  - Changed the name from AWS distribution of Kubeflow to Kubeflow on AWS to be consistent with website and usage tracking documentation
  - Added a section in vanilla Kubeflow readme: `Exposing Kubeflow over Load Balancer` to this [#67](#67) to expose deployment over LoadBalancer.
- adds fixes for a few broken links
- Sync the knative manifest for other deployment options with [vanilla](https://github.com/awslabs/kubeflow-manifests/blob/14c17ff16689dbf70af7fb7971deb7da63105690/docs/deployment/vanilla/kustomization.yaml#L17) corresponding to this [change](kubeflow/manifests#1966). This was a missed in initial PR because of looking at 2 branches to create this one

**Testing**
- links working as expected
- tested kfserving model using steps from #82 for the knative overlay change
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.

4 participants