Skip to content

Open-source status page, incident response and uptime monitoring

πŸ“š doc init (#154)

Thibault Le Ouay534b3aaadbd8
diff --git a/apps/docs/pages/_meta.json b/apps/docs/pages/_meta.json
index 951b457af..856193e0c 100644
--- a/apps/docs/pages/_meta.json
+++ b/apps/docs/pages/_meta.json
@@ -2,14 +2,11 @@
"index": "Introduction",
"get-started": "Get Started",
"community": "Community",
- "about": {
- "title": "About",
- "type": "page"
- },
+
"contact": {
- "title": "Contact β†—",
+ "title": "🌐 Website",
"type": "page",
- "href": "https://twitter.com/thibaultleouay",
+ "href": "https://www.openstatus.dev",
"newWindow": true
}
}
diff --git a/apps/docs/pages/about.mdx b/apps/docs/pages/about.mdx
deleted file mode 100644
index ec6faed87..000000000
--- a/apps/docs/pages/about.mdx
+++ /dev/null
@@ -1,3 +0,0 @@
-# About
-
-This is the about page! This page is shown on the navbar.
diff --git a/apps/docs/pages/community/contributing-guide.mdx b/apps/docs/pages/community/contributing-guide.mdx
index 45cec73f2..0acaed962 100644
--- a/apps/docs/pages/community/contributing-guide.mdx
+++ b/apps/docs/pages/community/contributing-guide.mdx
@@ -6,3 +6,62 @@ here.
This page provides instructions on how to edit the OpenStatus documentation. Our
goal is to ensure that everyone in the community feels empowered to contribute
and improve our docs.
+
+## Setup
+
+1. Clone the repository
+
+ ```sh
+ git clone https://github.com/openstatushq/openstatus.git
+ ```
+
+2. Install dependencies
+
+ ```sh
+ pnpm install
+ ```
+
+3. Database setup
+
+We are using Turso for the database to make it work locally you need to install
+it and run it.
+
+If you are on a mac install it with [Homebrew](https://brew.sh/)
+
+```sh
+brew tap chiselstrike/tap
+brew install turso
+```
+
+then run it locally with
+
+```sh
+turso dev --db-file openstatus.db
+```
+
+Here is the official Turso
+[installation guide](https://docs.turso.tech/reference/turso-cli)
+
+4. Run the database migration
+
+In the `packages/db` folder run
+
+```sh
+pnpm migrate
+```
+
+5. Set up your .env file
+
+from `apps/web` and `packages/db` you will find .env.example create your own.
+
+6. Clerk Authentication
+
+For authentication we are using [Clerk](https://clerk.dev/), you will need to
+create an account and get your API keys. If you want to work on the backend and
+or authenfied page
+
+After creating an account on clerk you will need to set up a tunnel with ngrok
+or svix to your local server.
+
+Otherwise you can send a post request to the `/api/webhook/clerk` endpoint with
+the following body you will find on clerk
diff --git a/apps/docs/pages/features.mdx b/apps/docs/pages/features.mdx
deleted file mode 100644
index 8a40b5e17..000000000
--- a/apps/docs/pages/features.mdx
+++ /dev/null
@@ -1,68 +0,0 @@
-# Markdown Syntax Cheat Sheet
-
-This Markdown file demonstrates various features of Markdown syntax:
-
-## Headings
-
-You can create headings using the '#' symbol. The number of '#' symbols
-represents the heading level.
-
-### Subheading
-
-#### Sub-subheading
-
-## Emphasis
-
-You can make text _italic_ or **bold**.
-
-## Lists
-
-### Unordered List
-
-- Item 1
-- Item 2
- - Nested Item 2.1
- - Nested Item 2.2
-- Item 3
-
-### Ordered List
-
-1. First Item
-2. Second Item
-3. Third Item
-
-## Links
-
-You can create [hyperlinks](https://www.example.com) like this.
-
-## Images
-
-You can include images like this.
-
-![Alt text](https://source.unsplash.com/random/500x400/?code)
-
-## Code Snippets
-
-### Inline Code
-
-To display inline code, use single backticks: `code`.
-
-### Code Blocks
-
-To show a block of code, use triple backticks:
-
-```js filename="demo.js" {3} copy
-let a = 1;
-
-console.log(a);
-```
-
-### Adding code to a Markdown file
-
-````md filename="demo.md" {3} copy
-```js filename="demo.js" {3} copy
-let a = 1;
-
-console.log(a);
-```
-````
diff --git a/apps/docs/pages/get-started.mdx b/apps/docs/pages/get-started.mdx
deleted file mode 100644
index bad55622f..000000000
--- a/apps/docs/pages/get-started.mdx
+++ /dev/null
@@ -1 +0,0 @@
-# Getting Started
diff --git a/apps/docs/pages/index.mdx b/apps/docs/pages/index.mdx
index 1c302035c..9f20df927 100644
--- a/apps/docs/pages/index.mdx
+++ b/apps/docs/pages/index.mdx
@@ -6,3 +6,18 @@ Documentation is still under construction.
OpenStatus is an open source alternative to your current monitoring service with
a beautiful status page.
+
+## Getting Started
+
+There are three ways to get started with OpenStatus.
+
+- Cloud: the fastest and easiest way to try the app (it's free)
+- Local: if you're a developer and would like to experiment or contribute to the
+ app
+- Self-hosting: if you want greater control over your data and want to run the
+ app on your own server
+
+## Contribution
+
+We love contribution, if you see any typo or have any suggestion, please feel to
+open a github issue.
diff --git a/apps/docs/theme.config.tsx b/apps/docs/theme.config.tsx
index ec5e91244..07c830183 100644
--- a/apps/docs/theme.config.tsx
+++ b/apps/docs/theme.config.tsx
@@ -8,7 +8,7 @@ const config: DocsThemeConfig = {
chat: {
link: "https://discord.com/invite/dHD4JtSfsn",
},
- docsRepositoryBase: "https://github.com/openstatusHQ/openstatus",
+ docsRepositoryBase: "https://github.com/openstatusHQ/openstatus/apps/docs",
footer: {
text: "OpenStatus Documentation",
},