diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa2ccf3f9..d96c99d0b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,9 @@ -# Contributing to Uptime Manager application +# Contributing to Checkmate First off, thanks for taking the time to contribute! ❤️ -All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how the Uptime Manager project handles them. Please make sure to read the relevant section before making your contribution. It will make it much easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 +All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how the Checkmate project handles them. Please make sure to read the relevant section before making your contribution. It will make it much easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 > And if you like the project, but don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: > - Star the project @@ -77,7 +77,7 @@ Once it's filed: This section guides you through submitting an enhancement suggestion for the application, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community understand your enhancements and find related suggestions. - Make sure that you are using the latest version. -- Make sure you run the code locally. The Uptime Manager [documentation](https://bluewavelabs.gitbook.io/uptime-manager) covers it. +- Make sure you run the code locally. The Checkmate [documentation](https://bluewavelabs.gitbook.io/checkmate) covers it. - Find out if the functionality is already covered, maybe by an individual configuration. - Perform a [search](/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. diff --git a/guides/.gitbook/assets/Screenshot 2024-10-10 at 10.37.36 PM.png b/guides/.gitbook/assets/Screenshot 2024-10-10 at 10.37.36 PM.png new file mode 100644 index 000000000..31dbacbe0 Binary files /dev/null and b/guides/.gitbook/assets/Screenshot 2024-10-10 at 10.37.36 PM.png differ diff --git a/guides/users-guide/maintenance-mode.md b/guides/users-guide/maintenance-mode.md new file mode 100644 index 000000000..7881dbfd8 --- /dev/null +++ b/guides/users-guide/maintenance-mode.md @@ -0,0 +1,35 @@ +--- +icon: clock-nine +--- + +# Maintenance mode + +The Maintenance mode allows you to manage and schedule maintenance periods for monitored URLs. During a maintenance window, no pings or HTTP requests are sent to the specified URLs, preventing downtime alerts during scheduled maintenance activities. + +### Creating a new maintenance window + +When you click the **"Create Maintenance Window"** button, you will see a page similar to this: + +
+ +Here's how to set up a new maintenance window: + +**General settings:** + +* **Maintenance repeat**: Select how often the maintenance window should repeat (e.g., don't repeat, daily, weekly). +* **Date**: Select the date the maintenance window should start. +* **Start time**: Set the time of day the window begins. +* **Duration**: Specify how long the maintenance window should last (in seconds, minutes, or hours). + +**Monitor related settings:** + +* **Friendly Name**: Provide a descriptive name for the maintenance window (e.g., "Maintenance at 10:37 PM for 30 minutes"). +* **Add Monitors**: Select the specific monitors (URLs) for which this maintenance window will apply by typing and selecting from the list. + +Once all fields are filled, click **Create maintenance** to save the new window. + +### Editing a maintenance window + +* To edit an existing window, click the gear icon under **Actions** in the table view. +* Update the required fields and save your changes. +