Skip to content
This repository has been archived by the owner on Aug 10, 2024. It is now read-only.

term: avoid "tutorial" #257

Merged
merged 1 commit into from
Dec 12, 2022
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 content/docs/command-reference/serve.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,5 +89,5 @@ built-in client, or common HTTP clients, such as [`curl`](https://curl.se/) and

## Examples

For examples, please refer to [Get Started](/doc/get-started) tutorial or the
[Serving User Guide](/doc/user-guide/serving).
For examples, please refer to the [Get Started](/doc/get-started) or the
[Serving guide](/doc/user-guide/serving).
8 changes: 4 additions & 4 deletions content/docs/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -514,11 +514,11 @@ you for checking out MLEM!

## What's next?

Please proceed to [Use Cases](/doc/use-cases) if you want to see high-level
scenarios MLEM can cover, or go to [User Guide](/doc/user-guide) to see more
details or short tutorials on how to use specific features of MLEM.
Please go to [Use Cases](/doc/use-cases) if you want to see high-level scenarios
MLEM can cover, or to the [User Guide](/doc/user-guide) to see more details and
examples on how to use specific features of MLEM.

If you have any questions or suggestions for us, please reach us out in
If you have any questions or suggestions for us, please reach out in
[Discord](https://discord.com/channels/485586884165107732/903647230655881226) or
create a new [GitHub issue](https://github.com/iterative/mlem/issues) in our
repo 🙌.
9 changes: 4 additions & 5 deletions content/docs/user-guide/building/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,10 @@ can run `mlem build --help` for list of builders and

## Pre-configured builders

In the [Get Started Tutorial](/doc/get-started) we demonstrated how to build a
docker image out of the model server. Now let's see what is the builder
declaration we mentioned there. You can pre-configure your builder in the form
of yaml file that we call "declaration" either manually or via `mlem declare`
command:
In the [Get Started](/doc/get-started) we demonstrated how to build a Docker
image out of the model server. Let's look into the builder declaration, which
you can pre-configure your builder with a YAML file (either manually or with
`mlem declare`):

```cli
$ mlem declare builder docker docker_builder.mlem \
Expand Down
20 changes: 11 additions & 9 deletions content/docs/user-guide/deploying/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,13 @@ pip install kubernetes docker
- Nodes are accessible and reachable, with an external IP address (valid for a
NodePort service, more details to come below).

One can access a
[basic](https://kubernetes.io/docs/tutorials/kubernetes-basics/) tutorial to
learn about the above terms.
<admon type="tip">

See the
[Kubernetes Basics](https://kubernetes.io/docs/tutorials/kubernetes-basics/) to
learn about the concepts above.

</admon>

## Description

Expand Down Expand Up @@ -216,19 +220,17 @@ simple and analogous to how it is done in the steps above for a local cluster

<admon type="info">

To setup an EKS cluster, you can simply use [`eksctl`](https://eksctl.io/)

A simple command such as
To set up an EKS cluster, you can use [`eksctl`](https://eksctl.io/):

```cli
eksctl create cluster --name cluster-name --region us-east-1
```

will setup an EKS cluster for you with default parameters such as two `m5.large`
worker nodes.
> This will provision an EKS cluster with default parameters, such as two
> `m5.large` worker nodes.

Other tools such as
[`terraform`](https://learn.hashicorp.com/tutorials/terraform/eks) can also be
[Terraform](https://learn.hashicorp.com/tutorials/terraform/eks) can also be
used.

</admon>
Expand Down
4 changes: 2 additions & 2 deletions content/docs/user-guide/dvc.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ datasets are too heavy to store in Git. To fix that, we suggest using
[stores objects in remote storages](https://dvc.org/doc/start/data-management/data-versioning),
allowing us to commit just pointers to them.

This page offers a small Tutorial on how to use DVC with already existing MLEM
project. We will reorganize our example repo to showcase that.
This page explains how to use DVC with an existing MLEM project. We will
reorganize our example repo to showcase that.

## Setting things up

Expand Down