docs: improve overall documentation
This commit is contained in:
19
.github/readme/partials/documentation/setup.md
vendored
Normal file
19
.github/readme/partials/documentation/setup.md
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
## 🦮 Setup
|
||||
|
||||
There are several ways to setup metrics, each having its advantages and disadvantages:
|
||||
|
||||
* [⚙️ Using GitHub Action on a profile repository *(~10 min)*](/.github/readme/partials/setup/action.md)
|
||||
* ✔️ All features
|
||||
* ✔️ High availability (no downtimes)
|
||||
* ➖ Configuration can be a bit time-consuming
|
||||
* [💕 Using the shared instance *(~1 min)*](/.github/readme/partials/setup/shared.md)
|
||||
* ✔️ Easily configurable and previewable
|
||||
* ➖ Limited features *(compute-intensive features are disabled)*
|
||||
* 🐳 Using command line with docker *(~5 min)* *(documentation not available yet)*
|
||||
* ✔️ Suited for one-time rendering
|
||||
* [🏗️ Deploying your own web instance *(~20 min)*](/.github/readme/partials/setup/web.md)
|
||||
* ➖ Mostly intended for development, or to create another shared instance
|
||||
|
||||
Additional resources for setup:
|
||||
* [🏦 Configuring metrics for organizations](/.github/readme/partials/organizations.md)
|
||||
* [🧰 Template/Plugin compatibility matrix](/.github/readme/partials/compatibility.md)
|
||||
Reference in New Issue
Block a user