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

Fix typos in markdown #1788

Merged
merged 1 commit into from
Oct 24, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions bootstrap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ You should have kubeflow components deployed inside your k8s cluster. Generated
Exec into pod ```kubeflow-bootstrapper-0``` in namespace ```kubeflow-admin``` if you need to edit your ksonnet app.

The default components are defined in [default.yaml](config/default.yaml), user can customize which components to deploy by
pointing ```--config``` args in [bootstrapper.yaml](./bootstrapper.yaml) to their own config (eg. a configmap in k8s clsuter)
pointing ```--config``` args in [bootstrapper.yaml](./bootstrapper.yaml) to their own config (eg. a configmap in k8s cluster)

This bootstrapper example [config](config/gcp_prototype.yaml) can help explain how config customization works.

Expand Down Expand Up @@ -164,7 +164,7 @@ Some options for dealing with this
- Downside of this is that it violates the K8s philosophy of managing infrastructure
declaratively
- It also means salient details about the deployment aren't stored in the configs
(ksonnet application) and versioned in source controle
(ksonnet application) and versioned in source control

1. Wrap the resource creation/management in a CRD using kube-metacontroller

Expand Down
2 changes: 1 addition & 1 deletion bootstrap/developer_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ go build -i -o ${GOPATH}/bin/bootstrapper ${GOPATH}/src/github.com/kubeflow/kube
The bootstrapper image defaults to [gcr.io/kubeflow-images-public/bootstrapper](https://gcr.io/kubeflow-images-public/bootstrapper).
This image copies the go executable /opt/kubeflow/bootstrapper built in the "builder" image which defaults to
[gcr.io/kubeflow-images-public/bootstrapper-builder](https://gcr.io/kubeflow-images-public/bootstrapper-builder).
Both are configurable by overridding environment variables used in the Makefile. Below are various examples that
Both are configurable by overriding environment variables used in the Makefile. Below are various examples that
show how and where these images are built and pushed.

1. Use a different gcloud project than kubeflow-images-public.
Expand Down
2 changes: 1 addition & 1 deletion docs_dev/ksonnet_packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Then replace the directory `vendor/kubeflow` with a symbolic link to `${GIT_KUBE
ln -sf ${GIT_KUBEFLOW}/kubeflow ${APP_DIR}/vendor/kubeflow
```

this way changes to your .libsonnet files will automaticaly be reflected in your components.
this way changes to your .libsonnet files will automatically be reflected in your components.

If you make changes to prototypes you need to regenerate the prototype. You can just delete the `.jsonnet`
file in your app's component directory and then regenerate the component using `ks generate`.
Expand Down
6 changes: 3 additions & 3 deletions docs_dev/kubeflow_deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Here are some **guidelines (not requirements)** for creating the above scripts a

* Scripts should create K8s clusters and supporting services as needed

* This is based on ancedetal evidence that most Kubeflow users to date
* This is based on anecdotal evidence that most Kubeflow users to date
are creating infrastructure specific for Kubeflow rather than deploying on
existing infrastructure.

Expand All @@ -121,7 +121,7 @@ Here are some **guidelines (not requirements)** for creating the above scripts a

* Declarative approaches to managing infrastructure (e.g. Terraform) are preferred

* Kubeflow aims to adopt K8s patterns; manging infrastructure declaratively
* Kubeflow aims to adopt K8s patterns; managing infrastructure declaratively
is one such pattern

* Another Kubeflow principle is low bar high ceiling
Expand All @@ -145,7 +145,7 @@ Here are some **guidelines (not requirements)** for creating the above scripts a
* To avoid hitting GitHub API limits and requiring users to create a GitHub token
the recommended approach is

1. Fetch and unback an archive copy of the repository.
1. Fetch and unpack an archive copy of the repository.

```
curl -L -O /tmp/source.tar.gz https://github.com/kubeflow/kubeflow/archive/v0.2.0.tar.gz
Expand Down
4 changes: 2 additions & 2 deletions docs_dev/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ the correct Docker image. See sections below for component specific instructions

1. Modify the script update_katib_ksonnet.sh

* set REALEASE to the tag you want to use
* set RELEASE to the tag you want to use

1. Run `update_katib_ksonnet.sh`

Expand Down Expand Up @@ -383,7 +383,7 @@ Ideally, this process will be automated to a greater extent in the future.
## Releasing a new version of the website

With each stable release, we should also release a corresponding version of the Kubeflow [website](www.kubeflow.org). Each version of the website is generated from a separate [branch](https://github.com/kubeflow/website/branches)
of the kubeflow/website repository. If documentation needs to be fixed, the changes should be commited to master and then cherry-picked to the proper release branch.
of the kubeflow/website repository. If documentation needs to be fixed, the changes should be committed to master and then cherry-picked to the proper release branch.

Releasing a new version on the website requires the following steps:

Expand Down
4 changes: 2 additions & 2 deletions docs_dev/tf_serving.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ See [detail](https://github.com/kubeflow/kubeflow/blob/master/components/k8s-mod
We are working on surfacing those metrics and other TF Serving specific metrics and integrating with Prometheus.
See [kubeflow/kubeflow#1036](https://github.com/kubeflow/kubeflow/issues/1036).

Also, there will be liveness and healthness check. See
Also, there will be liveness and health check. See
[issue](https://github.com/kubeflow/kubeflow/issues/368).

## Usage
Expand All @@ -64,7 +64,7 @@ Seldon to get nice features like routing and model management.
- [kubeflow/kubeflow#1000](https://github.com/kubeflow/kubeflow/issues/1000): Support logging request and response
to enable continuous training and skew detection
- [kubeflow/kubeflow#136](https://github.com/kubeflow/kubeflow/issues/136): Model management feature
- [kubeflow/kubeflw#1004](https://github.com/kubeflow/kubeflow/issues/1004): Examples showcasing CUJ
- [kubeflow/kubeflow#1004](https://github.com/kubeflow/kubeflow/issues/1004): Examples showcasing CUJ
- [kubeflow/kubeflow#1219](https://github.com/kubeflow/kubeflow/issues/1219): Autoscaling
- [kubeflow/kubebench#30](https://github.com/kubeflow/kubebench/issues/30): Benchmark to understand performance, like
autoscaling.
Expand Down
2 changes: 1 addition & 1 deletion kubeflow/seldon/json/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The temaplate json files are generated from seldon-core helm charts.
The template json files are generated from seldon-core helm charts.

The template_0.2.json is generated using:

Expand Down
2 changes: 1 addition & 1 deletion testing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ Make the service account a cluster admin
kubectl create clusterrolebinding ${SERVICE_ACCOUNT}-admin --clusterrole=cluster-admin \
--user=${SERVICE_ACCOUNT}@${PROJECT}.iam.gserviceaccount.com
```
* The service account is used to deploye Kubeflow which entails creating various roles; so it needs sufficient RBAC permission to do so.
* The service account is used to deploy Kubeflow which entails creating various roles; so it needs sufficient RBAC permission to do so.

### Create a GitHub Token

Expand Down