Skip to content

Commit

Permalink
Update Yatai new docs link and new TOC for ecosystem (#473)
Browse files Browse the repository at this point in the history
  • Loading branch information
jianshen92 authored Jun 10, 2023
1 parent 503ebe6 commit 37f95d2
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 10 deletions.
4 changes: 2 additions & 2 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ As you know, Kubernetes has a complex network environment, so developing cloud-n
Using a pre-installed Yatai in the development environment, the aim is to quickly provide a range of out-of-the-box infrastructure dependencies

You can start by reading this [installation document](https://docs.bentoml.org/projects/yatai/en/latest/installation/yatai.html) to install Yatai. It is highly recommended to use the [quick install script](https://docs.bentoml.org/projects/yatai/en/latest/installation/yatai.html#quick-install) to install Yatai
You can start by reading this [installation document](https://docs.yatai.io/en/latest/installation/yatai.html) to install Yatai. It is highly recommended to use the [quick install script](https://docs.yatai.io/en/latest/installation/yatai.html#quick-install) to install Yatai

Remember, **never use infrastructure from the production environment**, only use newly installed infrastructure in the cluster, such as SQL databases, blob storage, docker registry, etc. The [quick install script](https://docs.bentoml.org/projects/yatai/en/latest/installation/yatai.html#quick-install) mentioned above will prevent you from using the infrastructure in the production environment, this script will help you to install all the infrastructure from scratch, you can use it without any worries.
Remember, **never use infrastructure from the production environment**, only use newly installed infrastructure in the cluster, such as SQL databases, blob storage, docker registry, etc. The [quick install script](https://docs.yatai.io/en/latest/installation/yatai.html#quick-install) mentioned above will prevent you from using the infrastructure in the production environment, this script will help you to install all the infrastructure from scratch, you can use it without any worries.

If you have already installed it, please verify that your kubectl context is correct with the following command:

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 🦄️ Yatai: Model Deployment at Scale on Kubernetes

[![actions_status](https://github.com/bentoml/yatai/workflows/CICD/badge.svg)](https://github.com/bentoml/yatai/actions)
[![docs](https://readthedocs.org/projects/yatai/badge/?version=latest&style=flat-square)](https://docs.bentoml.org/projects/yatai)
[![docs](https://readthedocs.org/projects/yatai/badge/?version=latest&style=flat-square)](https://docs.yatai.io/en/latest/)
[![join_slack](https://badgen.net/badge/Join/Community%20Slack/cyan?icon=slack&style=flat-square)](https://join.slack.bentoml.org)

Yatai (屋台, food cart) lets you deploy, operate and scale Machine Learning services on Kubernetes.
Expand All @@ -28,16 +28,16 @@ It supports deploying any ML models via [BentoML: the unified model serving fram

🚅 Cloud native & DevOps friendly

- Kubernetes-native workflow via [BentoDeployment CRD](https://docs.bentoml.org/projects/yatai/en/latest/concepts/bentodeployment_crd.html) (Custom Resource Definition), which can easily fit into an existing GitOps workflow.
- Native [integration with Grafana](https://docs.bentoml.org/projects/yatai/en/latest/observability/metrics.html) stack for observability.
- Kubernetes-native workflow via [BentoDeployment CRD](https://docs.yatai.io/en/latest/concepts/bentodeployment_crd.html) (Custom Resource Definition), which can easily fit into an existing GitOps workflow.
- Native [integration with Grafana](https://docs.yatai.io/en/latest/observability/metrics.html) stack for observability.
- Support for traffic control with Istio.
- Compatible with all major cloud platforms (AWS, Azure, and GCP).


## Getting Started

- 📖 [Documentation](https://docs.bentoml.org/projects/yatai/) - Overview of the Yatai docs and related resources
- ⚙️ [Installation](https://docs.bentoml.org/projects/yatai/en/latest/installation/index.html) - Hands-on instruction on how to install Yatai for production use
- 📖 [Documentation](https://docs.yatai.io/) - Overview of the Yatai docs and related resources
- ⚙️ [Installation](https://docs.yatai.io/en/latest/installation/index.html) - Hands-on instruction on how to install Yatai for production use
- 👉 [Join Community Slack](https://l.linklyhq.com/l/ktPW) - Get help from our community and maintainers


Expand Down Expand Up @@ -65,7 +65,7 @@ This script will install Yatai along with its dependencies (PostgreSQL and MinIO
your minikube cluster.

Note that this installation script is made for development and testing use only.
For production deployment, check out the [Installation Guide](https://docs.bentoml.org/projects/yatai/en/latest/installation/index.html).
For production deployment, check out the [Installation Guide](https://docs.yatai.io/en/latest/installation/index.html).

To access Yatai web UI, run the following command and keep the terminal open:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@
linkcheck_allowed_redirects = {
r"http[s]://docs\.aws\.amazon\.com/.*": r"http[s]://docs\.aws\.amazon\.com/.*",
r"http[s]://docs\.bentoml\.org/.*": r"http[s]://docs\.bentoml\.org/en/latest/.*",
r"http[s]://docs\.bentoml\.org/projects/yatai.*": r"http[s]://docs\.bentoml\.org/projects/yatai/en/latest/.*",
r"http[s]://docs\.yatai\.io/.*": r"http[s]://docs\.yatai\.io/en/latest/.*",
r"http://modelserving\.com(/.*)?": r"https://modelserving\.com/.*",
r"https://l\.linklyhq\.com/.*": r"https://bentoml\.slack\.com/.*",
}
9 changes: 8 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,13 +107,20 @@ contributing to the project, helping other users and discuss all things MLOps.
GitHub <https://github.com/bentoml/Yatai>
Blog <https://modelserving.com>

.. toctree::
:caption: Ecosystem
:hidden:

🍱 BentoML <https://github.com/bentoml/BentoML>
☁️ BentoCloud <https://www.bentoml.com/bento-cloud/>
🚀 bentoctl <https://github.com/bentoml/bentoctl>

.. spelling::

.. |actions_status| image:: https://github.com/bentoml/Yatai/workflows/Lint/badge.svg
:target: https://github.com/bentoml/Yatai/actions
.. |documentation_status| image:: https://readthedocs.org/projects/yatai/badge/?version=latest&style=flat-square
:target: https://docs.bentoml.org/projects/yatai
:target: https://docs.yatai.io/en/latest/
.. |join_slack| image:: https://badgen.net/badge/Join/BentoML%20Slack/cyan?icon=slack&style=flat-square
:target: https://l.linklyhq.com/l/ktOX
.. |github_stars| image:: https://img.shields.io/github/stars/bentoml/Yatai?color=%23c9378a&label=github&logo=github&style=flat-square
Expand Down

0 comments on commit 37f95d2

Please sign in to comment.