From 993cd17d4f0712077d070066a441a441c6c28301 Mon Sep 17 00:00:00 2001 From: Oliver Date: Sat, 19 Apr 2025 14:38:22 +0200 Subject: [PATCH] docs: Update getting start pages for FancyAnalytics --- .../getting-started/getting-started.md | 34 ------------------- .../getting-started/getting-started.yml | 2 ++ .../getting-started/java-sdk.md | 7 +++- .../getting-started/minecraft-plugins.md | 8 ++++- .../getting-started/minecraft-servers.md | 7 +++- .../getting-started/rest-api.md | 7 +++- 6 files changed, 27 insertions(+), 38 deletions(-) delete mode 100644 docs/src/fancyanalytics/getting-started/getting-started.md create mode 100644 docs/src/fancyanalytics/getting-started/getting-started.yml diff --git a/docs/src/fancyanalytics/getting-started/getting-started.md b/docs/src/fancyanalytics/getting-started/getting-started.md deleted file mode 100644 index 11d0ab9b..00000000 --- a/docs/src/fancyanalytics/getting-started/getting-started.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -icon: info -order: 400 ---- - -There are multiple ways to send data to FancyAnalytics. - -!!! danger -The FancyAnalytics platform is still in development. Expect breaking changes in the future. -!!! - -### For Minecraft servers - -If you run a Minecraft server, you might want to track metrics about your players and server performance. -We provide a Minecraft plugin which can be installed on your server to send data to FancyAnalytics. -See the [Minecraft Servers](minecraft-servers.md) page for more information. - -### For Minecraft plugins - -If you are a Minecraft plugin developer, you might want to track metrics about your plugin usage. -So you know how many people are using your plugin and how they are using it. -We provide a Java SDK which is specifically designed for Minecraft plugins. -See the [Minecraft Plugins](minecraft-plugins.md) page for more information. - -### For Java developers - -If you are a Java developer, who wants to track metrics about your Java application, without being in the Minecraft ecosystem, you can use our Java SDK. -The Java SDK is a general purpose SDK which can be used to track metrics about any Java application. -See the [Java SDK](java-sdk.md) page for more information. - -### For everyone else - -If you are not a Java developer, or you are using a different programming language, you can use our REST API to send data to FancyAnalytics. -See the [REST API](rest-api.md) page for more information. \ No newline at end of file diff --git a/docs/src/fancyanalytics/getting-started/getting-started.yml b/docs/src/fancyanalytics/getting-started/getting-started.yml new file mode 100644 index 00000000..9147ea1a --- /dev/null +++ b/docs/src/fancyanalytics/getting-started/getting-started.yml @@ -0,0 +1,2 @@ +icon: info +order: 400 \ No newline at end of file diff --git a/docs/src/fancyanalytics/getting-started/java-sdk.md b/docs/src/fancyanalytics/getting-started/java-sdk.md index 245c1711..9fbb2437 100644 --- a/docs/src/fancyanalytics/getting-started/java-sdk.md +++ b/docs/src/fancyanalytics/getting-started/java-sdk.md @@ -5,7 +5,12 @@ order: 300 # Java SDK -This guide will help you set up FancyAnalytics in your general Java application. +!!! danger +The FancyAnalytics platform is still in development. Expect breaking changes in the future. +!!! + +If you are a Java developer, who wants to track metrics about your Java application, without being in the Minecraft ecosystem, you can use our Java SDK. +The Java SDK is a general purpose SDK which can be used to track metrics about any Java application. ## Include the Java SDK diff --git a/docs/src/fancyanalytics/getting-started/minecraft-plugins.md b/docs/src/fancyanalytics/getting-started/minecraft-plugins.md index ad92066b..d94058d2 100644 --- a/docs/src/fancyanalytics/getting-started/minecraft-plugins.md +++ b/docs/src/fancyanalytics/getting-started/minecraft-plugins.md @@ -5,7 +5,13 @@ order: 400 # Minecraft Plugins -This guide will help you set up FancyAnalytics in your Minecraft plugin. The API is very easy to use and has many default metrics. You can also define your own metrics and events. +!!! danger +The FancyAnalytics platform is still in development. Expect breaking changes in the future. +!!! + +If you are a Minecraft plugin developer, you might want to track metrics about your plugin usage. +So you know how many people are using your plugin and how they are using it. +We provide a Java SDK which is specifically designed for Minecraft plugins. ## Include the FancyAnalytics API diff --git a/docs/src/fancyanalytics/getting-started/minecraft-servers.md b/docs/src/fancyanalytics/getting-started/minecraft-servers.md index 9b0afe27..e9a1062f 100644 --- a/docs/src/fancyanalytics/getting-started/minecraft-servers.md +++ b/docs/src/fancyanalytics/getting-started/minecraft-servers.md @@ -5,7 +5,12 @@ order: 500 # Minecraft Servers -This guide will help you set up FancyAnalytics on your Minecraft server. The plugin already has many default metrics. +!!! danger +The FancyAnalytics platform is still in development. Expect breaking changes in the future. +!!! + +If you run a Minecraft server, you might want to track metrics about your players and server performance. +We provide a Minecraft plugin which can be installed on your server to send data to FancyAnalytics. ## Installation diff --git a/docs/src/fancyanalytics/getting-started/rest-api.md b/docs/src/fancyanalytics/getting-started/rest-api.md index 90ba1d02..502043f8 100644 --- a/docs/src/fancyanalytics/getting-started/rest-api.md +++ b/docs/src/fancyanalytics/getting-started/rest-api.md @@ -1,8 +1,13 @@ --- icon: dot order: 200 +visibility: hidden --- # REST API -TODO \ No newline at end of file +!!! danger +The FancyAnalytics platform is still in development. Expect breaking changes in the future. +!!! + +If you are not a Java developer, or you are using a different programming language, you can use our REST API to send data to FancyAnalytics.