Skip to content

Commit

Permalink
Updated docs pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Kevin Mattutat committed Nov 25, 2020
1 parent 89c082e commit 0aef342
Show file tree
Hide file tree
Showing 9 changed files with 131 additions and 9 deletions.
1 change: 1 addition & 0 deletions _sidebar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
- Getting started
- [Installation](de/install.md "Statisfying - Installation")
- Nutzung
- [Start](de/usage.md "Statisfying - Start")
- [Tabellen](de/usage-tables.md "Statisfying - Tabellen")
- [Charts](de/usage-graphs.md "Statisfying - Charts")

28 changes: 26 additions & 2 deletions de/usage-graphs.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,33 @@
# Grafiken

## Zeiteinstellungen

### Interval
Dieser Parameter gibt an, in welchen Zeitabständen die Daten gruppiert werden sollen.
Unterstützt werden folgende Intervale:

* Tage
* Wochen
* Monate
* Quartal
* Jahre

### Zeitraum
Dieser Parameter beeinflusst welcher Zeitraum bei der Anfrage bearbeitet werden soll.
Unterstützt werden folgende Zeiträume:

* 7 Tage
* 30 Tage
* 90 Tage
* 365 Tage


## Umsatz
Folgende Grafiken werden neben dem Umsatz dargestellt: Anzahl an Bestellungen, durschnittlicher Bestellwert, kleinster Bestellwert und größter Bestellwert.

### Zeiteinstellungen
![Statisfying Umsatz Charts Seite](./_media/Statisfying_ShopwareAdministration_Umsatz_Chart1.png)

## Aktionen
Zusätzlich zu den Zeiteinstellungen müssen eine oder mehrere Aktionen ausgewählt werden um eine Anfrage auszuführen. Diese Funktion ist besonders praktisch zum Vergleich von verschiedenen Aktionen.

### Zeiteinstellungen
![Statisfying Aktionen Umsatz Charts Seite](./_media/Statisfying_ShopwareAdministration_Promotion_Chart1.png)
27 changes: 27 additions & 0 deletions de/usage-tables.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,37 @@
# Tabellen
Eine listenförmige Zusammenstellung aus Daten zu einem bestimmten Kontext.

### Spalten
Die Spalten in der Tabelle können verwendet werden, um die Sortierung der Daten zu verändern. Folgende drei Zustände sind möglich:

* Inaktiv
* Absteigend
* Aufsteigend

Es kann immer nur ein Sortierfilter aktiv sein.

### Pagination
Der Begriff Pagination kann mit “Seitennummerierung” ins Deutsche übersetzt werden.
Bei langen Auflistungen von Daten kann so die Ladezeit und Übersichtlichkeit der Tabelle verbessert werden.

* Die aktuelle Seite kann mittig am unteren Rand ausgewählt werden.
* Die gewünschte Anzahl an Einträgen kann über den Selector am rechten unteren Rand verändert werden.

## Umsatz
![Statisfying Umsatz Tabellen Seite](./_media/Statisfying_ShopwareAdministration_Umsatz_Tabelle.png)

### Zeiteinstellungen
Über die vertikale Leiste auf der linken Seite sind verschiedene Intervalle auswählbar. Unterstützt werden folgende:

* Tage
* Wochen
* Monate
* Quartal
* Jahre

## Aktionen
![Statisfying Aktionen Tabellen Seite](./_media/Statisfying_ShopwareAdministration_Promotion_Tabelle.png)


## CSV Export
Ein CSV-Export kann durch Klicken auf die Download-Schaltfläche ausgelöst werden.
Expand Down
10 changes: 10 additions & 0 deletions de/usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Start

Der Einstiegspunkt des Plugins kann unter *Einstellungen**Plugins* gefunden werden. Klicken Sie auf den Statisfying Eintrag um zur Übersicht zu gelangen.

![Statisfying im Plugins Reiter der Einstellungen](./_media/Statisfying_ShopwareAdministration_SettingsItem.png)

### Startseite
Über die Startseite sind alle Funktionen kategorisiert verfügbar. Über den jeweiligen Eintrag kann die entsprechende Detailseite aufgerufen werden.

![Statisfying Index Seite](./_media/Statisfying_ShopwareAdministration_Index.png)
1 change: 1 addition & 0 deletions en/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
- Getting started
- [Installation](en/install.md "Statisfying - Installation")
- Usage
- [Start](en/usage.md "Statisfying - Start")
- [Tables](en/usage-tables.md "Statisfying - Table Usage")
- [Charts](en/usage-graphs.md "Statisfying - Charts Usage")

27 changes: 25 additions & 2 deletions en/usage-graphs.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,32 @@
# Charts

## Time settings

### Interval
This parameter specifies the time intervals at which the data should be grouped.
The following intervals are supported:

* days
* weeks
* months
* quarter
* years

### Period
This parameter influences which time period should be processed for the request.
The following time periods are supported:

* 7 days
* 30 days
* 90 days
* 365 days

## Revenue
The following graphics are shown next to the revenue: Number of orders, average order value, smallest order value and largest order value.

### Time settings
![Statisfying revenue charts page](./_media/Statisfying_ShopwareAdministration_Umsatz_Chart1.png)

## Promotions
In addition to the time settings, one or more promotions must be selected to execute a request. This function is especially useful for comparing different promotions.

### Time settings
![Statisfying promotions revenue charts page](./_media/Statisfying_ShopwareAdministration_Promotion_Chart1.png)
34 changes: 30 additions & 4 deletions en/usage-tables.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,39 @@
# Tables
# Tabellen
A list of data for a specific context.

### Columns
The columns in the table can be used to change the sorting of the data. The following three states are possible:

* Inactive
* Descending
* Ascending

Only one sorting filter can be active at a time.

### Pagination
For long listings of data, this can improve the loading time and clarity of the table.

* The current page can be selected in the middle of the bottom margin.
* The desired number of entries can be changed using the selector at the bottom right.

## Revenue
![Statisfying revenue table page](./_media/Statisfying_ShopwareAdministration_Umsatz_Tabelle.png)

### Time period settings
The vertical bar on the left side allows you to select different time intervals. The following are supported:

### Time settings
* days
* weeks
* months
* quarter
* years

## Promotions
![Statisfying promotions revenue table page](./_media/Statisfying_ShopwareAdministration_Promotion_Tabelle.png)


## CSV Export
A CSV export can be triggered by clicking the Download button.

A CSV export can be triggered by clicking the download button.
![CSV Download Button](./_media/CSV_download_button.png)

![CSV Download Button](./_media/CSV_download_button.png)
10 changes: 10 additions & 0 deletions en/usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Start

The entry point of the plugin can be found under *Settings**Plugins*. Click on the Statisfying entry to get to the overview page.

![Statisfying in the plugin tab of the settings page](./_media/Statisfying_ShopwareAdministration_SettingsItem.png)

### Startseite
All functions are categorized and available on the start page. Using an entry leads to the corresponding detail page.

![Statisfying index page](./_media/Statisfying_ShopwareAdministration_Index.png)
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta charset="UTF-8">
<title>Statisfying Docs</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="A truly satisfying statistic plugin">
<meta name="description" content="The documentation page for a truly satisfying statistic plugin">
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">

<!-- Latest https://github.com/jhildenbiddle/docsify-themeable -->
Expand Down

0 comments on commit 0aef342

Please sign in to comment.