✍️ add more docs (#859)

openstatusHQ · Jun 3, 2024 · 39b00b0 · 39b00b0
1 parent 422757c
commit 39b00b0
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 34 deletions.
diff --git a/Docker/clickhouse/docker-compose.yaml b/Docker/clickhouse/docker-compose.yaml
diff --git a/apps/docs/images/monitor/public-monitor.png b/apps/docs/images/monitor/public-monitor.png
diff --git a/apps/docs/images/monitor/setting-public-monitor.png b/apps/docs/images/monitor/setting-public-monitor.png
diff --git a/apps/docs/mint.json b/apps/docs/mint.json
@@ -160,7 +160,7 @@
           ]
         },
         {
-          "group": "Page",
+          "group": "Status Page",
           "pages": [
             "api-reference/page/get-page",
             "api-reference/page/get-page-id",

diff --git a/apps/docs/synthetic/features/monitor.mdx b/apps/docs/synthetic/features/monitor.mdx
@@ -93,6 +93,33 @@ We currently support the following assertions on the following fields:
 - **Status Code**
 - **Response Body**
 
+
+## Public Monitor 🌐
+
+You can make your monitor public by checking **Allow public monitor**.
+
+<Frame caption="Public monitor setting">
+  <img
+    src="/images/monitor/setting-public-monitor.png"
+    alt="Public monitor setting"
+  />
+</Frame>
+
+
+
+A public monitor is accessible by anyone with the monitor URL.
+e.g. https://status.openstatus.dev/monitors/1
+
+
+<Frame caption="Public monitor">
+  <img
+    src="/images/monitor/public-monitor.png"
+    alt="Public monitor"
+  />
+</Frame>
+
+If the monitor is attached to a **status page**, the monitor will be displayed on the status page in the **Monitors** tab.
+
 ## Video Tutorial 📺
 
 <iframe width="560" height="315" src="https://www.youtube.com/embed/nYti3DjHoWY?si=RBGFHzoHFmwphRft" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
diff --git a/apps/docs/synthetic/features/status-page.mdx b/apps/docs/synthetic/features/status-page.mdx
@@ -41,12 +41,16 @@ If you want the dark version of the badge, you can use the following URL:
 
 You can also customize the size of the badge by adding a `size` parameter:
 
-- `sm
+- `sm`
 - `md`
 - `lg`
 - `xl`
 
 
 ```html
 <img src="https://YOUR-SLUG.openstatus.dev/badge?theme=dark&size=xl" />
-```
+```
+
+##  Add monitors metrics 📊
+
+If you make your <a href="/synthetic/features/monitor#public-monitor">monitor public</a>, you can display the metrics on your status page.
diff --git a/apps/docs/synthetic/overview.mdx b/apps/docs/synthetic/overview.mdx
@@ -11,7 +11,7 @@ responses.
 
 We will alert you if your website or API is down, slow or does not return the expected response.
 
-You can create monitors in our dashboard, with the API or with Terraform.
+You can create monitors in our dashboard, with the <a href="/api-reference/monitor/post-monitor">API</a> or with <a href="/packages/terraform">Terraform</a>.
 
 ## Locations 🌍