Skip to content

Commit 567b509

Browse files
Apply suggestions from code review
Co-authored-by: Benedikt Rollik <[email protected]>
1 parent 6f73431 commit 567b509

File tree

1 file changed

+14
-11
lines changed
  • tutorials/deploy-mdbooks-serverless-containers

1 file changed

+14
-11
lines changed

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

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
meta:
33
title: Fast deployment of documentation on Serverless Containers with mdbooks
4-
description: Step-by-step guide to deploy mdbooks on Serverless Containers.
4+
description: Step-by-step guide to deploy mdbooks on Scaleway Serverless Containers.
55
content:
6-
h1: Deploying mdbooks on Serverless Containers
7-
paragraph:
6+
h1: Fast deployment of documentation on Serverless Containers with mdbooks
7+
paragraph: Step-by-step guide to deploy mdbooks on Scaleway Serverless Containers.
88
tags: docker container deploy serverless
99
hero: assets/scaleway-umami.webp
1010
categories:
@@ -17,7 +17,7 @@ dates:
1717

1818
Publish modern online books, for product, API documentation, tutorials, course material or anything that requires a clean, easily navigable and customizable presentation.
1919

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
20+
This tutorial uses `mdbooks` to publish simple documentation but the main goal of this tutorial is to show how simple it is to
2121
pick a project, package it inside an image and deploy it on Serverless Containers.
2222

2323
<Macro id="requirements" />
@@ -28,21 +28,21 @@ pick a project, package it inside an image and deploy it on Serverless Container
2828

2929
## Why deploying on Serverless
3030

31-
Serverless products are perfect for cost efficiency with a pay-as-you go model and scales very well.
31+
Serverless products are perfect for cost efficiency with a pay-as-you-go model and scale very well.
3232

33-
With zero infrastructure management a lot of tools to integrate in CI/CD environments, `mdbooks` can benefits a lot of Serverless Containers.
33+
With zero infrastructure management and many tools to integrate in CI/CD environments, `mdbooks` can benefit a lot of Serverless Containers.
3434

3535
## Local setup
3636

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

3939
2. Run commands:
4040
- `mdbook init my-first-book` in order to create a sample book.
4141
- `cd my-first-book` to open the directory created by init command.
4242

4343
3. *(optional)* Now you can edit the content of the book to publish.
4444

45-
4. It's recommanded to test the book using the command: `mdbook test`.
45+
4. It is recommended to test the book using the command: `mdbook test`.
4646

4747
## Prepare Container Registry
4848

@@ -73,7 +73,7 @@ ENV PATH="$PATH:/home/mdbooks"
7373
ENTRYPOINT ["mdbook", "serve", "-n", "0.0.0.0", "-p", "8080" ]
7474
```
7575

76-
2. Open Container Registry product on Scaleway Console.
76+
2. Open a web browser on your computer and navigate to the [Container Registry](https://console.scaleway.com/containers/) product in the Scaleway Console.
7777
3. Click **Create namespace**. A namespace is used to hold the image.
7878

7979
<Message type="note">
@@ -82,7 +82,10 @@ ENTRYPOINT ["mdbook", "serve", "-n", "0.0.0.0", "-p", "8080" ]
8282

8383
4. Create the namespace and save the registry endpoint. The registry endpoint looks like `rg.<region>.scw.cloud/<namespace>`
8484

85-
## Build and Push
85+
<Message type="note">
86+
Refer to [How to create a namespace](/docs/containers/container-registry/how-to/create-namespace/) for detailed information about Container Registry namespace creation.
87+
</Message>
88+
## Build and push
8689

8790
1. Run the command `docker build -t rg.<region>.scw.cloud/<namespace>/<image_name>:<tag_name> .`
8891
* **region**: to get this information, check the namespace settings of the namespace you created.
@@ -94,7 +97,7 @@ ENTRYPOINT ["mdbook", "serve", "-n", "0.0.0.0", "-p", "8080" ]
9497

9598
## Deploy the Serverless Container
9699

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

0 commit comments

Comments
 (0)