From 6726009ca77efd89be6278359b735eb5d18919ac Mon Sep 17 00:00:00 2001 From: Mathias Wagner Date: Fri, 12 Jul 2024 21:56:24 +0200 Subject: [PATCH] Migrate instructions/settings.md page --- docs/de/instructions/settings.md | 99 ++++++++++++++++++++++++++++++++ docs/en/instructions/settings.md | 98 +++++++++++++++++++++++++++++++ docs/instructions/settings.de.md | 91 ----------------------------- docs/instructions/settings.en.md | 89 ---------------------------- 4 files changed, 197 insertions(+), 180 deletions(-) create mode 100644 docs/de/instructions/settings.md create mode 100644 docs/en/instructions/settings.md delete mode 100644 docs/instructions/settings.de.md delete mode 100644 docs/instructions/settings.en.md diff --git a/docs/de/instructions/settings.md b/docs/de/instructions/settings.md new file mode 100644 index 00000000..fad265d2 --- /dev/null +++ b/docs/de/instructions/settings.md @@ -0,0 +1,99 @@ +# Settings + +![Letzter Test](/assets/images/de/settings.png){align="right"} + +Clicking on the **settings-icon** ⚙️ opens the settings page. You can find an example on the right. + +In this menu you can find settings as well as functions like exporting tests. + +To make the design clearer, the settings related to the internet can be found in the first 4 lines. + +All options related to speed tests can be found in the 2nd box. Here you can e.g. set the frequency of the tests or +select a server. + +In the 3rd box you can find settings related to the interface. Here you can change the language or the view. + +
+ +## Internet related settings + +Here are settings that relate to your optimal Internet. + +::: tip What's the point? +MySpeed uses colored icons to symbolize the quality of your internet connection. If you enter these values here, MySpeed +will show you by icons if your internet is good, medium or bad. +::: + +### 🏓 Ping + +The ping is a value that shows the duration of the connection between your computer and the internet in **ms**. +The faster (i.e. lower), the better. + +### ⬆️ Up-Speed + +The up-speed is the speed at which your computer sends data. The higher the value, the better. + +### ⬇️ Down-Speed + +The down-speed is the speed at which your computer receives data. The higher the value, the better. + +### 🛠️ Optimal values + +If you don't know what values you should enter here, you can use this button. MySpeed will then try to determine the +optimal values for you. + +## Speedtest settings + +### 🖥️ Change server + +MySpeed chooses the next server automatically at startup. But if you find a closer server, you can select it here. You +can choose one from the list or enter an ID. You can read more about this [here](https://www.ookla.com/network). + +### 🔑 Change password + +Is your MySpeed instance public and you don't want others or only authorized people to see your internet speed? Then you +can protect MySpeed with a password here, which has to be entered when visiting the site. + +### 🕒 Set frequency + +Here you can set the frequency in which MySpeed performs your tests. This setting can be relevant for slower +connections. + +### ⏸️ Pause speed tests + +Do you have to upload an important document right now and MySpeed is affecting your internet speed a lot? Then you can +pause it here for a certain time. This can be relevant especially for slow connections. + +### 🌐 Integrations + +MySpeed uses integrations to notify you when your internet is down. You have services like Discord, Telegram, or Gotify +to choose from. If you want to process the data yourself, you can also specify a webhook and have all events sent to +you. + +## Interface settings + +### 📅 Set period + +Here you can define how many tests will be displayed in the specified period. You can choose between the last 24 and 48 +hours as well as the last 7 or 30 days. If you select one of the last two, you will be shown averages to make the +interface clearer. + +### 📤 Export tests + +Do you want to be sure and download your tests to your computer? Then you can export your tests here. + +### 🌍 Change language + +MySpeed is currently available in English and German languages. With this option you can change the language. Do you +want to participate and translate MySpeed into another language? Then have a +look [here](https://crowdin.com/project/myspeed). + +### 📊 Change view + + +MySpeed offers you two views. The first one is the default view you already know. The second one is the **Test +Statistics**. Here you can see all tests with the help of widgets and diagrams. + +### ℹ️ Information + +This section shows you information about your MySpeed instance. Nothing important, just a little info. :) \ No newline at end of file diff --git a/docs/en/instructions/settings.md b/docs/en/instructions/settings.md new file mode 100644 index 00000000..3fbd341a --- /dev/null +++ b/docs/en/instructions/settings.md @@ -0,0 +1,98 @@ +# Settings + +![Latest test](/assets/images/en/settings.png){align="right"} + +Clicking on the **settings-icon** ⚙️ opens the settings page. You can find an example on the right. + +In this menu you can find settings as well as functions like exporting tests. + +To make the design clearer, the settings related to the internet can be found in the first 4 lines. + +All options related to speed tests can be found in the 2nd box. Here you can e.g. set the frequency of the tests or +select a server. + +In the 3rd box you can find settings related to the interface. Here you can change the language or the view. + +
+ +## Internet related settings + +Here are settings that relate to your optimal Internet. + +::: tip What's the point? +MySpeed uses colored icons to symbolize the quality of your internet connection. If you enter these values here, MySpeed +will show you by icons if your internet is good, medium or bad. +::: + +### 🏓 Ping + +The ping is a value that shows the duration of the connection between your computer and the internet in **ms**. +The faster (i.e. lower), the better. + +### ⬆️ Up-Speed + +The up-speed is the speed at which your computer sends data. The higher the value, the better. + +### ⬇️ Down-Speed + +The down-speed is the speed at which your computer receives data. The higher the value, the better. + +### 🛠️ Optimal values + +If you don't know what values you should enter here, you can use this button. MySpeed will then try to determine the +optimal values for you. + +## Speedtest settings + +### 🖥️ Change server + +MySpeed chooses the next server automatically at startup. But if you find a closer server, you can select it here. You +can choose one from the list or enter an ID. You can read more about this [here](https://www.ookla.com/network). + +### 🔑 Change password + +Is your MySpeed instance public and you don't want others or only authorized people to see your internet speed? Then you +can protect MySpeed with a password here, which has to be entered when visiting the site. + +### 🕒 Set frequency + +Here you can set the frequency in which MySpeed performs your tests. This setting can be relevant for slower +connections. + +### ⏸️ Pause speed tests + +Do you have to upload an important document right now and MySpeed is affecting your internet speed a lot? Then you can +pause it here for a certain time. This can be relevant especially for slow connections. + +### 🌐 Integrations + +MySpeed uses integrations to notify you when your internet is down. You have services like Discord, Telegram, or Gotify +to choose from. If you want to process the data yourself, you can also specify a webhook and have all events sent to +you. + +## Interface settings + +### 📅 Set period + +Here you can define how many tests will be displayed in the specified period. You can choose between the last 24 and 48 +hours as well as the last 7 or 30 days. If you select one of the last two, you will be shown averages to make the +interface clearer. + +### 📤 Export tests + +Do you want to be sure and download your tests to your computer? Then you can export your tests here. + +### 🌍 Change language + +MySpeed is currently available in English and German languages. With this option you can change the language. Do you +want to participate and translate MySpeed into another language? Then have a +look [here](https://crowdin.com/project/myspeed). + +### 📊 Change view + +MySpeed offers you two views. The first one is the default view you already know. The second one is the **Test +Statistics**. Here you can see all tests with the help of widgets and diagrams. + +### ℹ️ Information + +This section shows you information about your MySpeed instance. Nothing important, just a little info. :) \ No newline at end of file diff --git a/docs/instructions/settings.de.md b/docs/instructions/settings.de.md deleted file mode 100644 index 5bb6d5a2..00000000 --- a/docs/instructions/settings.de.md +++ /dev/null @@ -1,91 +0,0 @@ -# Einstellungen - -![Letzter Test](/assets/images/de/settings.png){align="right"} - -Mit einem Klick auf das **Einstellungs-Icon :material-cog:** öffnet sich die Einstellungsseite. Du findest ein Beispiel -dazu rechts. - -In diesem Menü lassen sich sowohl Einstellungen als auch Funktionen wie das Exportieren von Tests wiederfinden. - -Um das Design übersichtlicher zu gestalten, finden sich die Einstellungen bezogen auf das Internet in den ersten 4 -Zeilen. - -Alle Optionen, die sich auf Speedtests beziehen, sind im 2. Kasten zu finden. Hier kannst du z.B. die Häufigkeit der -Tests einstellen oder einen Server auswählen. - -Im 3. Kasten findest du Einstellungen, die sich auf das Interface beziehen. Hier kannst du z.B. die Sprache ändern oder -die Ansicht wechseln. - -
- -## Internetbezogene Einstellungen - -Hierbei handelt es sich um Einstellungen, die sich auf dein optimales Internet beziehen. - -!!! tip "Was ist der Sinn dahinter?" - MySpeed verwendet farbige Icons, um die Qualität deiner Internetverbindung zu symbolisieren. Gibst du in diesen - Einstellungen das Internet deines Anbieters an, wird MySpeed dir anhand von Symbolen zeigen, ob dein Internet gut, - mittelmäßig oder schlecht ist. - -=== ":material-tennis: Ping" - Der Ping ist ein Wert, der die Dauer der Verbindung zwischen deinem Computer und dem Internet in **ms** anzeigt. - Je schneller (also niedriger), desto besser. - -=== ":material-arrow-up: Up-Speed" - Der Up-Speed ist die Geschwindigkeit, mit der dein Computer Daten sendet. Je höher der Wert, desto besser. - -=== ":material-arrow-down: Down-Speed" - Der Down-Speed ist die Geschwindigkeit, mit der dein Computer Daten empfängt. Je höher der Wert, desto besser. - -=== ":material-auto-fix: Optimale Werte" - Wenn du nicht weißt, welche Werte du hier eingeben sollst, kannst du diese Schaltfläche verwenden. MySpeed wird - dann versuchen, die optimalen Werte für dich zu ermitteln. - -## Speedtest-Einstellungen - -=== ":material-server: Server wechseln" - MySpeed sucht sich schon beim Start automatisch den nächsten Server aus. Solltest du allerdings einen näheren - Server finden, kannst du diesen hier auswählen. Du kannst hierbei einen aus der Liste wählen oder eine ID eingeben. - Mehr dazu erfährst du [hier](https://www.ookla.com/network) - -=== ":material-key: Passwort ändern" - Ist deine MySpeed-Instanz öffentlich und du möchtest nicht, dass andere oder nur autorisierte Personen deine Internetgeschwindigkeit - einsehen können? Dann kannst du hier MySpeed mit einem Passwort schützen, welches beim Besuch der Seite eingegeben werden muss. - -=== ":material-clock: Häufigkeit einstellen" - Hier kannst du die Häufigkeit angeben, in der MySpeed deine Tests durchführt. Diese Einstellung kann gerade bei - langsameren Verbindungen relevant sein. - -=== ":material-pause: Speedtests pausieren" - Musst du gerade ein wichtiges Dokument hochladen und MySpeed beeinträchtigt deine Internetgeschwindigkeit sehr? Dann - kannst du sie hier für eine bestimmte Zeit pausieren. Dies kann gerade bei langsamen Verbindungen relevant sein. - -=== ":material-webhook: Integrationen" - ![Integrationen](/assets/images/de/integrations.png){align="right"} - - MySpeed verwendet Integrationen, um dich zu benachrichtigen, wenn dein Internet ausfällt. - Dabei hast du Dienste wie Discord, Telegram oder Gotify zur Auswahl. Möchtest du die Daten selbst verarbeiten, kannst du - auch einen Webhook angeben und dir alle Events zuschicken lassen. - -## Interface-Einstellungen - -=== ":material-calendar-month: Zeitraum festlegen" - Hier kannst du festlegen, wie viele Tests dir im angegebenen Zeitraum angezeigt werden. Dabei kannst du auswählen zwischen den - letzten 24 und 48 Stunden sowie den letzten 7 oder 30 Tagen. Wählst du eines der beiden letzten aus, so werden dir Durchschnitte - angezeigt, um das Interface übersichtlich zu gestalten. - -=== ":material-file-export: Tests exportieren" - Möchtest du mal sicher gehen und deine Tests auf deinen Computer laden? Dann kannst du hier deine Tests exportieren. - -=== ":material-globe-model: Sprache ändern" - MySpeed ist derzeit in Deutsch und Englisch Sprachen verfügbar. Mit dieser Option kannst du die Sprache ändern. - Möchtest du mitwirken und MySpeed in eine weitere Sprache übersetzen? Dann schau doch mal [hier](https://crowdin.com/project/myspeed). - -=== ":material-equalizer: Ansicht wechseln" - ![Ansicht wechseln](/assets/images/de/view.png){align="right"} - - MySpeed bietet dir zwei Ansichten an. Die erste ist die Standardansicht, die du bereits kennst. Die zweite ist die - **Test-Statistik**. Hier werden dir alle Tests mithilfe von Widgets und Diagrammen angezeigt. - -=== ":material-information: Information" - Dieser Bereich zeigt dir Informationen über deine MySpeed-Instanz. Nichts Wichtiges, einfach nur eine kleine Info. :) \ No newline at end of file diff --git a/docs/instructions/settings.en.md b/docs/instructions/settings.en.md deleted file mode 100644 index d554e5d4..00000000 --- a/docs/instructions/settings.en.md +++ /dev/null @@ -1,89 +0,0 @@ -# settings - -![Last test](/assets/images/en/settings.png){align="right"} - -Clicking on the **settings-icon :material-cog:** opens the settings page. You can find an example -on the right. - -In this menu you can find settings as well as functions like exporting tests. - -To make the design clearer, the settings related to the internet can be found in the first 4 -lines. - -All options related to speed tests can be found in the 2nd box. Here you can e.g. set the frequency of the -tests or select a server. - -In the 3rd box you can find settings related to the interface. Here you can change the language or the view. -change the view. - -
- -## Internet related settings - -Here are settings that relate to your optimal Internet. - -!!! tip "What's the point?" - MySpeed uses colored icons to symbolize the quality of your internet connection. - If you enter these values here, MySpeed will show you by icons if your internet is good, medium or bad. - -=== ":material-tennis: Ping" - The ping is a value that shows the duration of the connection between your computer and the internet in **ms**. - The faster (i.e. lower), the better. - -=== ":material-arrow-up: Up-Speed" - The up-speed is the speed at which your computer sends data. The higher the value, the better. - -=== ":material-arrow-down: Down-Speed" - The down-speed is the speed at which your computer receives data. The higher the value, the better. - -=== ":material-auto-fix: Optimal values" - If you don't know what values you should enter here, you can use this button. MySpeed will then try to determine the optimal values for you. - -## Speedtest settings - -=== ":material-server: Change server" - MySpeed chooses the next server automatically at startup. But if you find a closer server, - you can select it here. You can choose one from the list or enter an ID. - You can read more about this [here](https://www.ookla.com/network) - -=== ":material-key: Change password" - Is your MySpeed instance public and you don't want others or only authorized people to see your internet speed? - Then you can protect MySpeed with a password here, which has to be entered when visiting the site. - -=== ":material-clock: Set frequency" - Here you can set the frequency in which MySpeed performs your tests. This setting can be relevant for - slower connections. - -=== ":material-pause: Pause speed tests" - Do you have to upload an important document right now and MySpeed is affecting your internet speed a lot? Then - you can pause it here for a certain time. This can be relevant especially for slow connections. - -=== ":material-webhook: Integrations" - ![integrations](/assets/images/en/integrations.png){align="right"} - - MySpeed uses integrations to notify you when your internet is down. - You have services like Discord, Telegram or Gotify to choose from. If you want to process the data yourself, you can also specify a - webhook and have all events sent to you. - -## Interface settings - -=== ":material-calendar-month: Set period" - Here you can define how many tests will be displayed in the specified period. You can choose between - the last 24 and 48 hours as well as the last 7 or 30 days. If you select one of the last two, you will be shown averages to make the - to make the interface clearer. - -=== ":material-file-export: Export tests" - Do you want to be sure and download your tests to your computer? Then you can export your tests here. - -=== ":material-globe-model: Change language" - MySpeed is currently available in English and German languages. With this option you can change the language. - Do you want to participate and translate MySpeed into another language? Then have a look [here](https://crowdin.com/project/myspeed). - -=== ":material-equalizer: Change view" - ![Change view](/assets/images/en/view.png){align="right"} - - MySpeed offers you two views. The first one is the default view you already know. The second one is the - **Test Statistics**. Here you can see all tests with the help of widgets and diagrams. - -=== ":material-information: Information" - This section shows you information about your MySpeed instance. Nothing important, just a little info. :) \ No newline at end of file