Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
📝 docs clean (#847)
Thibault Le Ouay26d46fc08561
diff --git a/apps/docs/api-reference/incident/get-incident:id.mdx b/apps/docs/api-reference/incident/get-incident-id.mdxsimilarity index 100%rename from apps/docs/api-reference/incident/get-incident:id.mdxrename to apps/docs/api-reference/incident/get-incident-id.mdxdiff --git a/apps/docs/api-reference/incident/put-incident:id.mdx b/apps/docs/api-reference/incident/put-incident-id.mdxsimilarity index 100%rename from apps/docs/api-reference/incident/put-incident:id.mdxrename to apps/docs/api-reference/incident/put-incident-id.mdxdiff --git a/apps/docs/api-reference/monitor/delete-monitor:id.mdx b/apps/docs/api-reference/monitor/delete-monitor-id.mdxsimilarity index 100%rename from apps/docs/api-reference/monitor/delete-monitor:id.mdxrename to apps/docs/api-reference/monitor/delete-monitor-id.mdxdiff --git a/apps/docs/api-reference/monitor/get-monitor:id.mdx b/apps/docs/api-reference/monitor/get-monitor-id.mdxsimilarity index 100%rename from apps/docs/api-reference/monitor/get-monitor:id.mdxrename to apps/docs/api-reference/monitor/get-monitor-id.mdxdiff --git a/apps/docs/api-reference/monitor/get-monitor:id/summary.mdx b/apps/docs/api-reference/monitor/get-monitor-id/summary.mdxsimilarity index 100%rename from apps/docs/api-reference/monitor/get-monitor:id/summary.mdxrename to apps/docs/api-reference/monitor/get-monitor-id/summary.mdxdiff --git a/apps/docs/api-reference/monitor/put-monitor:id.mdx b/apps/docs/api-reference/monitor/put-monitor-id.mdxsimilarity index 100%rename from apps/docs/api-reference/monitor/put-monitor:id.mdxrename to apps/docs/api-reference/monitor/put-monitor-id.mdxdiff --git a/apps/docs/api-reference/notification/get-notification:id.mdx b/apps/docs/api-reference/notification/get-notification-id.mdxsimilarity index 100%rename from apps/docs/api-reference/notification/get-notification:id.mdxrename to apps/docs/api-reference/notification/get-notification-id.mdxdiff --git a/apps/docs/api-reference/page/post-page:id/update.mdx b/apps/docs/api-reference/page/post-page-id/update.mdxsimilarity index 100%rename from apps/docs/api-reference/page/post-page:id/update.mdxrename to apps/docs/api-reference/page/post-page-id/update.mdxdiff --git a/apps/docs/api-reference/page/put-page:id.mdx b/apps/docs/api-reference/page/put-page-id.mdxsimilarity index 100%rename from apps/docs/api-reference/page/put-page:id.mdxrename to apps/docs/api-reference/page/put-page-id.mdxdiff --git a/apps/docs/api-reference/status_report/delete-status_report:id.mdx b/apps/docs/api-reference/status_report/delete-status_report-id.mdxsimilarity index 100%rename from apps/docs/api-reference/status_report/delete-status_report:id.mdxrename to apps/docs/api-reference/status_report/delete-status_report-id.mdxdiff --git a/apps/docs/api-reference/status_report/get-status_report:id.mdx b/apps/docs/api-reference/status_report/get-status_report-id.mdxsimilarity index 100%rename from apps/docs/api-reference/status_report/get-status_report:id.mdxrename to apps/docs/api-reference/status_report/get-status_report-id.mdxdiff --git a/apps/docs/api-reference/status_report/post-status_report:id/update.mdx b/apps/docs/api-reference/status_report/post-status_report-id/update.mdxsimilarity index 100%rename from apps/docs/api-reference/status_report/post-status_report:id/update.mdxrename to apps/docs/api-reference/status_report/post-status_report-id/update.mdxdiff --git a/apps/docs/api-reference/status_report_update/get-status_report_update:id.mdx b/apps/docs/api-reference/status_report_update/get-status_report_update-id.mdxsimilarity index 100%rename from apps/docs/api-reference/status_report_update/get-status_report_update:id.mdxrename to apps/docs/api-reference/status_report_update/get-status_report_update-id.mdxdiff --git a/apps/docs/contributing/get-started.mdx b/apps/docs/contributing/get-started.mdxindex 11922bb3c..55aa0e6d8 100644--- a/apps/docs/contributing/get-started.mdx+++ b/apps/docs/contributing/get-started.mdx@@ -24,44 +24,22 @@ 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+4. Install Bun+All the up to date information are on the official [Bun website](https://bun.sh/)-In the `packages/db` folder run+4. Set up the dev environment```sh-pnpm migrate+ pnpm dx```--5. Set up your .env file--from `apps/web` and `packages/db` you will find .env.example. Please create your-own.--6. Start the web app locally+5. Start the development server```sh-pnpm dev+ pnpm dev:web```-> 💡 If you are getting this error --> `ERROR run failed: error preparing engine: Invalid persistent task configuration: You have 15 persistent tasks but`turbo`is configured for concurrency of 10. Set --concurrency to at least 16`-> Then `cd` into web directory and then start the web app->-> ```sh-> cd apps/web-> pnpm dev-> ```+6. Open your browser and navigate to [http://localhost:3000](http://localhost:3000)\ No newline at end of filediff --git a/apps/docs/contributing/requirements.mdx b/apps/docs/contributing/requirements.mdxindex dc7fef709..f478d0d77 100644--- a/apps/docs/contributing/requirements.mdx+++ b/apps/docs/contributing/requirements.mdx@@ -64,25 +64,6 @@ If you want to use a local database, it is recommended to install "brew" andTo install brew, it is recommended to use brew.sh from[https://brew.sh/](https://brew.sh/) and follow its instructions.-### Installing sqld--Once you have installed it and performed updates with-`brew update --auto-update`, you can install "sqld" as follows:--```bash-brew tap libsql/sqld-brew install sqld-beta-sqld --help-```--> _Note: Please ensure to add sqld to you system PATH_--This will allow you to work with the local database without modifying the ".env"-file.--Please note that these optional requirements are only necessary if you want to-use a local database. Otherwise, you can continue with the rest of the-configuration as mentioned previously.### Installing Tursodiff --git a/apps/docs/contributing/setup-env.mdx b/apps/docs/contributing/setup-env.mdxindex 4d6c849ab..65ee2dc5e 100644--- a/apps/docs/contributing/setup-env.mdx+++ b/apps/docs/contributing/setup-env.mdx@@ -6,8 +6,7 @@ title: Setup environment filesThe `.env` file contains various environment variables that need to be properlyconfigured for the application to work correctly. Below, I will explain how to-obtain the values for some of these variables, focusing on the section related-to Cleark Auth.+obtain the values for some of these variables.## Setting up Resend for sending emailsdiff --git a/apps/docs/contributing/setup.mdx b/apps/docs/contributing/setup.mdxdeleted file mode 100644index d7de2b4fe..000000000--- a/apps/docs/contributing/setup.mdx+++ /dev/null@@ -1,64 +0,0 @@-----title: Setup------Follow these steps for setup:--### Clone the repository--To get started, clone the OpenStatus repository by running the following command-in your terminal or command prompt:--```bash-git clone https://github.com/openstatusHQ/openstatus.git-```--### Install dependencies--Once the repository is cloned, navigate to the `openstatus` directory using the-command:--```bash-cd openstatus-```--Next, use pnpm to install the required dependencies. Execute the following-command:--```bash-pnpm install-```--### Configure .env files--To configure the application, you need to set certain environment variables in a-`.env` file. You will find an example file named `.env.example` in the-`apps/web` and `packages/db` directories. Copy this file and rename it to-`.env`. Then, edit the `.env` file with specific values required for your-configuration.--You can use any text editor, or manually copy it into an empty .env file or-whatever you want to do.--For example, you can use a text editor (nano) to open the `.env` file:--```bash-# apps/web-cp apps/web/.env.example apps/web/.env-nano apps/web/.env--# packages/db-cp packages/db/.env.example packages/db/.env-nano packages/db/.env-```--Make sure to provide appropriate values for each variable defined in the `.env`-file. These variables may include configurations related to the database, API-credentials, etc.--⚠️ Keep in mind that the `.env` file should be kept **private** and should not-be shared publicly as it may contain sensitive information such as passwords or-access keys.--Once you have completed these steps, you will have finished the setup and-configuration of OpenStatus, and you'll be ready to start the application.diff --git a/apps/docs/mint.json b/apps/docs/mint.jsonindex 4cc6e0ed5..6633c015d 100644--- a/apps/docs/mint.json+++ b/apps/docs/mint.json@@ -122,8 +122,7 @@"pages": ["contributing/requirements","contributing/get-started",- "contributing/setup-env",- "contributing/setup"+ "contributing/setup-env"]},{@@ -134,26 +133,26 @@{"group": "Incident","pages": [- "api-reference/incident/get-incident:id",+ "api-reference/incident/get-incident-id","api-reference/incident/get-incident",- "api-reference/incident/put-incident:id"+ "api-reference/incident/put-incident-id"]},{"group": "Monitor","pages": [- "api-reference/monitor/get-monitor:id",+ "api-reference/monitor/get-monitor-id","api-reference/monitor/get-monitor",- "api-reference/monitor/delete-monitor:id",+ "api-reference/monitor/delete-monitor-id","api-reference/monitor/post-monitor",- "api-reference/monitor/put-monitor:id"+ "api-reference/monitor/put-monitor-id"]},{"group": "Notification","pages": ["api-reference/notification/get-notification",- "api-reference/notification/get-notification:id",+ "api-reference/notification/get-notification-id","api-reference/notification/post-notification"]},@@ -161,26 +160,26 @@"group": "Page","pages": ["api-reference/page/get-page",- "api-reference/page/get-page:id",+ "api-reference/page/get-page-id","api-reference/page/post-page",- "api-reference/page/put-page:id",- "api-reference/page/post-page:id/update"+ "api-reference/page/put-page-id",+ "api-reference/page/post-page-id/update"]},{"group": "Status Report","pages": [- "api-reference/status_report/get-status_report:id",+ "api-reference/status_report/get-status_report-id","api-reference/status_report/get-status_report",- "api-reference/status_report/delete-status_report:id",+ "api-reference/status_report/delete-status_report-id","api-reference/status_report/post-status_report",- "api-reference/status_report/post-status_report:id/update"+ "api-reference/status_report/post-status_report-id/update"]},{"group": "Status Report Udpate","pages": [- "api-reference/status_report_update/get-status_report_update:id",+ "api-reference/status_report_update/get-status_report_update-id","api-reference/status_report_update/post-status_report_update"]},diff --git a/apps/docs/synthetic/overview.mdx b/apps/docs/synthetic/overview.mdxindex 5bd9dec7c..e70e498d6 100644--- a/apps/docs/synthetic/overview.mdx+++ b/apps/docs/synthetic/overview.mdx@@ -3,7 +3,7 @@ title: Overviewdescription: "How does OpenStatus' synthetic monitoring work?"----With our synthetic monitoring, you can track the availability and performance of+With our synthetic monitoring, you can monitor the availability and performance ofyour website or API from various global locations.We will monitor your website or API on a regular schedule and record the