feat: add some admonitions

alexandre-touret · Jan 10, 2024 · 46c73ba · 46c73ba
1 parent 0e01e27
commit 46c73ba
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 23 deletions.
diff --git a/docs/01-without_versioning.md b/docs/01-without_versioning.md
@@ -4,10 +4,11 @@ At this point we have our first customer : **John Doe** who uses our API with th
 
 ## TL;DR: What will you learn in this chapter?
 
-This chapter covers the following topics:
-
-1. How to start the platform
-2. Adding a non-breaking change and see how it doesn't impact the API Contract 
+> [!IMPORTANT]
+> This chapter covers the following topics:
+> 1. How to start the platform
+> 2. Adding a non-breaking change and see how it doesn't impact the API Contract
+>
 
 ## Prerequisites
 

diff --git a/docs/02-first_version.md b/docs/02-first_version.md
@@ -2,12 +2,15 @@
 
 ## TL;DR: What will you learn in this chapter?
 
-This chapter covers the following topics:
+> [!IMPORTANT]
+> This chapter covers the following topics:
+> 1. Pinpoint the impacts of the versioning in the OPENAPI Description file
+> 2. Implement a URL Based versioning
+> 3. Implement a header based versioning
+> 4. Deploy and configure a default version for your API
+>
+
 
-1. Pinpoint the impacts of the versioning in the OPENAPI Description file
-2. Implement a URL Based versioning
-3. Implement a header based versioning
-4. Deploy and configure a default version for your API
 
 ## Prerequisites
 We will define in this chapter our first version in the URI and in a header mixing in the gateway & the apps.

diff --git a/docs/03-second_version.md b/docs/03-second_version.md
@@ -2,10 +2,11 @@
 
 ## TL;DR: What are you going to learn in this chapter?
 
-This chapter covers the following topics:
-
-1. Creating a new version (it will be a copy of the rest-book module)
-2. Add a new breaking change functionality to the last version
+> [!IMPORTANT]
+> This chapter covers the following topics:
+> 1. Creating a new version (it will be a copy of the rest-book module)
+> 2. Add a new breaking change functionality to the last version
+>
 
 ## A new functionality for a new customer
 

diff --git a/docs/04-scm.md b/docs/04-scm.md
@@ -2,10 +2,14 @@
 
 ## TL;DR: What are you going to learn in this chapter?
 
-This chapter covers the following topics:
 
-1. Pinpoint Configuration management issues due to API Versioning 
-2. Exposing the two versions on the API Gateway
+
+> [!IMPORTANT]
+> This chapter covers the following topics:
+> 1. Pinpoint Configuration management issues due to API Versioning
+> 2. Exposing the two versions on the API Gateway
+
+
 
 ## Preamble
 You can configure your services either during deployment using CI tooling, such as [Gitlab Environments](https://docs.gitlab.com/ee/ci/environments/), or any other [Infra As Code](https://en.wikipedia.org/wiki/Infrastructure_as_code) tool ([Istio](https://istio.io/), [Ansible](https://www.ansible.com/),...) or using a configuration server.

diff --git a/docs/05-conflicts.md b/docs/05-conflicts.md
@@ -2,9 +2,10 @@
 
 ## TL;DR: What are you going to learn in this chapter?
 
-This chapter covers the following topics:
 
-1. Dig into Backward compatibility hassle and implement a solution to make both of the two versions work
+> [!IMPORTANT]
+> This chapter covers the following topics:
+> 1. Dig into Backward compatibility hassle and implement a solution to make both of the two versions work
 
 ## Preamble
 

diff --git a/docs/06-authorization.md b/docs/06-authorization.md
@@ -2,10 +2,12 @@
 
 ## TL;DR: What are you going to learn in this chapter?
 
-This chapter covers the following topics:
 
-1. Pinpointing the impacts on authorization
-2. Enforcing API versions restrictions with OAUTHv2 scopes
+> [!IMPORTANT]
+> This chapter covers the following topics:
+> 1. Pinpointing the impacts on authorization
+> 2. Enforcing API versions restrictions with OAUTHv2 scopes
+>
 
 While versioning secured APIs, there is usually one impact we miss at the beginning: security, especially authorization.
 If you apply authorization policies on your whole platform using for instance, [ABAC](https://en.wikipedia.org/wiki/Attribute-based_access_control) or [RBAC](https://en.wikipedia.org/wiki/Role-based_access_control) approaches, you must take care about it.

diff --git a/docs/index.md b/docs/index.md
@@ -19,8 +19,7 @@ Here is how this repository is organised and a short explanation:
 
 ### :computer: Infrastructure
 
-:warning: The required infrastructure is available by
-running [Docker containers](https://www.docker.com/resources/what-container/).
+:warning: The required infrastructure is available by running [Docker containers](https://www.docker.com/resources/what-container/).
 
 You can start the whole by running [Docker compose](https://docs.docker.com/compose/).