Update docs (#1674)

Author: vishalbollu

.dockerignore

@@ -2,7 +2,7 @@
 /bin/
 /dev/
 /docs/
-/examples/
+/test/
 
 **/.*
 **/*.md

.gitbook.yaml

@@ -1,13 +1,5 @@
 root: ./docs/
 
 structure:
-  readme: ../README.md
+  readme: ./tutorials/realtime.md
   summary: summary.md
-
-redirects:
-  tutorial: ../examples/pytorch/text-generator/README.md
-  tutorial/realtime: ../examples/pytorch/text-generator/README.md
-  tutorial/batch: ../examples/batch/image-classifier/README.md
-  install: ./cloud/install.md
-  uninstall: ./cloud/uninstall.md
-  update: ./cloud/update.md

CODE_OF_CONDUCT.md

@@ -3,10 +3,6 @@
 
 <br>
 
-<!-- Delete on release branches -->
-<!-- CORTEX_VERSION_README_MINOR -->
-[install](https://docs.cortex.dev/install) • [documentation](https://docs.cortex.dev) • [examples](https://github.com/cortexlabs/cortex/tree/0.23/examples) • [community](https://gitter.im/cortexlabs/cortex)
-
 # Deploy machine learning models to production
 
 Cortex is an open source platform for deploying, managing, and scaling machine learning in production.
@@ -56,8 +52,6 @@ cortex is ready!
 #### Implement a predictor
 
 ```python
-# predictor.py
-
 from transformers import pipeline
 
 class PythonPredictor:
@@ -74,20 +68,13 @@ class PythonPredictor:
 api_spec = {
   "name": "text-generator",
   "kind": "RealtimeAPI",
-  "predictor": {
-    "type": "python",
-    "path": "predictor.py"
-  },
   "compute": {
     "gpu": 1,
-    "mem": "8Gi",
+    "mem": "8Gi"
   },
   "autoscaling": {
     "min_replicas": 1,
     "max_replicas": 10
-  },
-  "networking": {
-    "api_gateway": "public"
   }
 }
 ```
@@ -108,19 +95,15 @@ api_spec = {
 import cortex
 
 cx = cortex.client("aws")
-cx.deploy(api_spec, project_dir=".")
+cx.create_api(api_spec, predictor=PythonPredictor)
 
 # creating https://example.com/text-generator
 ```
 
 #### Consume your API
 
-```python
-import requests
-
-endpoint = "https://example.com/text-generator"
-payload = {"text": "hello world"}
-prediction = requests.post(endpoint, payload)
+```bash
+$ curl https://example.com/text-generator -X POST -H "Content-Type: application/json" -d '{"text": "hello world"}'
 ```
 
 <br>
@@ -131,4 +114,4 @@ prediction = requests.post(endpoint, payload)
 pip install cortex
 ```
 
-See the [installation guide](https://docs.cortex.dev/install) for next steps.
+[Deploy models](https://docs.cortex.dev) and [join our community](https://gitter.im/cortexlabs/cortex).

CONTRIBUTING.md

@@ -74,7 +74,7 @@ output=$(cd "$ROOT" && find . -type f \
 ! -path "**/.idea/*" \
 ! -path "**/.history/*" \
 ! -path "**/__pycache__/*" \
-! -path "./examples/*" \
+! -path "./test/*" \
 ! -path "./dev/config/*" \
 ! -path "./bin/*" \
 ! -path "./.circleci/*" \
@@ -137,25 +137,12 @@ if [ "$is_release_branch" = "true" ]; then
     exit 1
   fi
 
-  # Check for version warning comments in examples
-  output=$(cd "$ROOT/examples" && find . -type f \
-  ! -name "README.md" \
-  ! -name "*.json" \
-  ! -name "*.txt" \
-  ! -name ".*" \
-  ! -name "*.bin" \
-  -exec grep -L -e "this is an example for cortex release ${git_branch} and may not deploy correctly on other releases of cortex" {} \;)
-  if [[ $output ]]; then
-    echo "examples file(s) are missing appropriate version comment:"
-    echo "$output"
-    exit 1
-  fi
-
 else
   # Check for version warning comments in docs
   output=$(cd "$ROOT/docs" && find . -type f \
   ! -path "./README.md" \
   ! -name "summary.md" \
+  ! -path "./tutorials/*" \
   ! -name "development.md" \
   ! -name "*.json" \
   ! -name "*.txt" \
@@ -167,21 +154,6 @@ else
     echo "$output"
     exit 1
   fi
-
-  # Check for version warning comments in examples
-  output=$(cd "$ROOT/examples" && find . -type f \
-  ! -path "./README.md" \
-  ! -path "**/__pycache__/*" \
-  ! -name "*.json" \
-  ! -name "*.txt" \
-  ! -name ".*" \
-  ! -name "*.bin" \
-  -exec grep -L "WARNING: you are on the master branch; please refer to examples on the branch corresponding to your \`cortex version\` (e\.g\. for version [0-9]*\.[0-9]*\.\*, run \`git checkout -b [0-9]*\.[0-9]*\` or switch to the \`[0-9]*\.[0-9]*\` branch on GitHub)" {} \;)
-  if [[ $output ]]; then
-    echo "example file(s) are missing version appropriate comment:"
-    echo "$output"
-    exit 1
-  fi
 fi
 
 # Check for trailing whitespace

README.md

@@ -19,7 +19,7 @@ set -eou pipefail
 ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")"/.. >/dev/null && pwd)"
 CORTEX="$ROOT/bin/cortex"
 
-for example in $ROOT/examples/*/cortex.yaml; do
+for example in $ROOT/test/*/cortex.yaml; do
   timer=1200
   example_base_dir=$(dirname "${example}")
   retry="false"

build/lint.sh

@@ -62,7 +62,7 @@ func ErrorFailedToConnectOperator(originalError error, envName string, operatorU
 		msg += fmt.Sprintf("    → otherwise you can ignore this message, and prevent it in the future with `cortex env delete %s`\n", envName)
 		msg += "\nif you have a cluster running:\n"
 		msg += fmt.Sprintf("    → run `cortex cluster info --configure-env %s` to update your environment (include `--config <cluster.yaml>` if you have a cluster configuration file)\n", envName)
-		msg += fmt.Sprintf("    → if you set `operator_load_balancer_scheme: internal` in your cluster configuration file, your CLI must run from within a VPC that has access to your cluster's VPC (see https://docs.cortex.dev/v/%s/aws/vpc-peering)\n", consts.CortexVersionMinor)
+		msg += fmt.Sprintf("    → if you set `operator_load_balancer_scheme: internal` in your cluster configuration file, your CLI must run from within a VPC that has access to your cluster's VPC (see https://docs.cortex.dev/v/%s/)\n", consts.CortexVersionMinor)
 	}
 
 	return errors.WithStack(&errors.Error{

build/test-examples.sh

@@ -249,7 +249,7 @@ func ErrorMissingAWSCredentials() error {
 func ErrorCredentialsInClusterConfig(cmd string, path string) error {
 	return errors.WithStack(&errors.Error{
 		Kind:    ErrCredentialsInClusterConfig,
-		Message: fmt.Sprintf("specifying credentials in the cluster configuration is no longer supported, please specify aws credentials using flags (e.g. cortex cluster %s --config %s --aws-key <AWS_ACCESS_KEY_ID> --aws-secret <AWS_SECRET_ACCESS_KEY>) or set environment variables; see https://docs.cortex.dev/v/%s/aws/security#iam-permissions for more information", cmd, path, consts.CortexVersionMinor),
+		Message: fmt.Sprintf("specifying credentials in the cluster configuration is no longer supported, please specify aws credentials using flags (e.g. cortex cluster %s --config %s --aws-key <AWS_ACCESS_KEY_ID> --aws-secret <AWS_SECRET_ACCESS_KEY>) or set environment variables; see https://docs.cortex.dev/v/%s/ for more information", cmd, path, consts.CortexVersionMinor),
 	})
 }
 
@@ -343,6 +343,6 @@ func ErrorDeployFromTopLevelDir(genericDirName string, providerType types.Provid
 	}
 	return errors.WithStack(&errors.Error{
 		Kind:    ErrDeployFromTopLevelDir,
-		Message: fmt.Sprintf("cannot deploy from your %s directory - when deploying your API, cortex sends all files in your project directory (i.e. the directory which contains cortex.yaml) to your %s (see https://docs.cortex.dev/v/%s/deployments/realtime-api/predictors#project-files for Realtime API and https://docs.cortex.dev/v/%s/deployments/batch-api/predictors#project-files for Batch API); therefore it is recommended to create a subdirectory for your project files", genericDirName, targetStr, consts.CortexVersionMinor, consts.CortexVersionMinor),
+		Message: fmt.Sprintf("cannot deploy from your %s directory - when deploying your API, cortex sends all files in your project directory (i.e. the directory which contains cortex.yaml) to your %s (see https://docs.cortex.dev/v/%s/); therefore it is recommended to create a subdirectory for your project files", genericDirName, targetStr, consts.CortexVersionMinor),
 	})
 }

cli/cluster/errors.go

@@ -69,7 +69,7 @@ func promptIfNotAdmin(awsClient *aws.Client, disallowPrompt bool) {
 	}
 
 	if !awsClient.IsAdmin() {
-		warningStr := fmt.Sprintf("warning: your IAM user%s does not have administrator access. This will likely prevent Cortex from installing correctly, so it is recommended to attach the AdministratorAccess policy to your IAM user (or to a group that your IAM user belongs to) via the AWS IAM console. If you'd like, you may provide separate credentials for your cluster to use after it's running (see https://docs.cortex.dev/v/%s/aws/security for instructions).\n\n", accessKeyMsg, consts.CortexVersionMinor)
+		warningStr := fmt.Sprintf("warning: your IAM user%s does not have administrator access. This will likely prevent Cortex from installing correctly, so it is recommended to attach the AdministratorAccess policy to your IAM user (or to a group that your IAM user belongs to) via the AWS IAM console. If you'd like, you may provide separate credentials for your cluster to use after it's running (see https://docs.cortex.dev/v/%s/).\n\n", accessKeyMsg, consts.CortexVersionMinor)
 		if disallowPrompt {
 			fmt.Print(warningStr)
 		} else {