Skip to content

Commit 544a217

Browse files
polish text
1 parent b81f031 commit 544a217

File tree

1 file changed

+18
-13
lines changed
  • tutorials/deploy-mdbooks-serverless-containers

1 file changed

+18
-13
lines changed

tutorials/deploy-mdbooks-serverless-containers/index.mdx

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@ dates:
1515
posted:
1616
---
1717

18-
Publish modern online books, for product, API documentation, tutorials, course material or anything that requires a clean, easily navigable and customizable presentation.
18+
Publish modern online books, for product, API documentation, tutorials, course material or anything that requires a clean, easily navigable and customizable presentation.
19+
20+
**Goal** this tutorial uses `mdbooks` to publish simple documentation but the main goal of this tutorial is to show how simple it is to
21+
pick a project, package it inside an image and deploy it on Serverless Containers.
1922

2023
<Macro id="requirements" />
2124

@@ -31,15 +34,15 @@ With zero infrastructure management a lot of tools to integrate in CI/CD environ
3134

3235
## Local setup
3336

34-
Follow [Istallation instructions](https://rust-lang.github.io/mdBook/guide/installation.html) of mdbooks.
37+
1. Follow [Istallation instructions](https://rust-lang.github.io/mdBook/guide/installation.html) of mdbooks.
3538

36-
Run:
39+
2. Run commands:
3740
- `mdbook init my-first-book` in order to create a sample book.
38-
- `cd my-first-book`
41+
- `cd my-first-book` to open the directory created by init command.
3942

40-
Now you can edit the content of the book to publish.
43+
3. *(optional)* Now you can edit the content of the book to publish.
4144

42-
It's recommanded to test the book using the command: `mdbook test`.
45+
4. It's recommanded to test the book using the command: `mdbook test`.
4346

4447
## Prepare Container Registry
4548

@@ -74,10 +77,10 @@ ENTRYPOINT ["mdbook", "serve", "-n", "0.0.0.0", "-p", "8080" ]
7477
3. Click **Create namespace**. A namespace is used to hold the image.
7578

7679
<Message type="note">
77-
A pop-up will appear with informations to log into your Container Registry Namespace. This will allow to push the image later.
80+
A pop-up will appear with informations to log into your Container Registry Namespace with `docker login`. This will allow to push the image later.
7881
</Message>
7982

80-
4. Create the namespace and save the registry endpoint. It should be something like `rg.fr-par.scw.cloud/<namespace>`
83+
4. Create the namespace and save the registry endpoint. The registry endpoint looks like `rg.<region>.scw.cloud/<namespace>`
8184

8285
## Build and Push
8386

@@ -92,15 +95,17 @@ ENTRYPOINT ["mdbook", "serve", "-n", "0.0.0.0", "-p", "8080" ]
9295
## Deploy the Serverless Container
9396

9497
1. Create a Serverless Container Namespace. [Link to console](https://console.scaleway.com/containers/namespaces/create)
95-
2. Configure the Serverless Containers. Important points are:
96-
* **Image**: Select the Registry namespace, Container and Tag you created before using the dropdowns.
98+
2. Configure the Serverless Containers. **Important points are:**
99+
* **Image**: Select the Registry namespace, Container and Tag you created before using the dropdown lists.
97100
* **Name**: You can change the default name to use a more meaningful one.
98101

99102
You can keep default values of other parameters and fine-tune them later at anytime without downtime.
100103

101-
3. Click "Deploy container" button and wait few seconds for the deployment.
102-
4. Congratulation you Serverless Container is deployed an ready :)
104+
3. Click **Deploy container** button and wait few seconds for the deployment.
105+
4. Congratulation you Serverless Container is deployed an ready. You can access it via it's **endpoint**.
103106

104107
## Going further
105108

106-
- Integrate in CI/CD
109+
* [Monitor logs and metrics](/serverless/containers/how-to/monitor-container/) of your Container.
110+
* [Add a custom domain](/serverless/containers/how-to/add-a-custom-domain-to-a-container/) to your Container.
111+
* Explore [other methods](/serverless/containers/reference-content/deploy-container/) to deploy your Container.

0 commit comments

Comments
 (0)