From 18da1df71e538cd98032937c542154f0efcb6fbb Mon Sep 17 00:00:00 2001 From: jwijenbergh Date: Mon, 1 May 2023 15:18:40 +0200 Subject: Docs: Move state machine to API --- docs/src/gettingstarted/building.md | 0 docs/src/gettingstarted/debugging/README.md | 6 ------ docs/src/gettingstarted/debugging/fsm.md | 21 --------------------- docs/src/gettingstarted/debugging/fsm_example.svg | 1 - docs/src/gettingstarted/debugging/logging.md | 8 -------- 5 files changed, 36 deletions(-) delete mode 100644 docs/src/gettingstarted/building.md delete mode 100644 docs/src/gettingstarted/debugging/README.md delete mode 100644 docs/src/gettingstarted/debugging/fsm.md delete mode 100644 docs/src/gettingstarted/debugging/fsm_example.svg delete mode 100644 docs/src/gettingstarted/debugging/logging.md (limited to 'docs/src/gettingstarted') diff --git a/docs/src/gettingstarted/building.md b/docs/src/gettingstarted/building.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/src/gettingstarted/debugging/README.md b/docs/src/gettingstarted/debugging/README.md deleted file mode 100644 index 0b402a9..0000000 --- a/docs/src/gettingstarted/debugging/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# Debugging - -To debug this library, e.g. to discover bugs or to see how it works internally, the library comes with a few nice additions. - -## The debug variable -To enable debugging, set debugging to True in the method that registers the code with the library (see [API](../api/index.html)). This sets the logging level to `INFO` (meaning show all messages), and generates a Finite State Machine (FSM) `.graph` file. We explain in more detail what these two components (logging and FSM) exactly are and how they can be used. diff --git a/docs/src/gettingstarted/debugging/fsm.md b/docs/src/gettingstarted/debugging/fsm.md deleted file mode 100644 index 45ed281..0000000 --- a/docs/src/gettingstarted/debugging/fsm.md +++ /dev/null @@ -1,21 +0,0 @@ -# Finite state machine - -The eduvpn-common library uses a finite state machine internally to keep track of which state the client is in and to communicate data callbacks (e.g. to communicate the Authorization URL in the OAuth process to the client). - -## Viewing the FSM -To view the FSM in an image, set the debug variable to `True`. This -outputs the graph with a `.graph` extension in the client-specified -config directory (See [API](../../api/index.html)). The format of this -graph is from [Mermaid](https://mermaid-js.github.io/mermaid/#/). You -can convert this to an image using the [Mermaid command-line client](https://github.com/mermaid-js/mermaid-cli) installed or from the Mermaid web site, the [Mermaid Live Editor](https://mermaid.live) - -## FSM example -The following is an example of the FSM when the client has obtained a Wireguard/OpenVPN configuration from an eduVPN server - -![](./fsm_example.svg) - -The current state is highlighted in the cyan color. - -## State explanation - -For the explanation of what all the different states mean, see the [API documentation](/api/overview/index.md#states) diff --git a/docs/src/gettingstarted/debugging/fsm_example.svg b/docs/src/gettingstarted/debugging/fsm_example.svg deleted file mode 100644 index eed1532..0000000 --- a/docs/src/gettingstarted/debugging/fsm_example.svg +++ /dev/null @@ -1 +0,0 @@ -
Client registers
Reload list
User clicks a server in the UI
Location chosen
Go back or Error
Server has been chosen
Go back or Error
Server info loaded
User chooses a Secure Internet server but no location is configured
Go back or Error
Found tokens in config
No tokens found in config
User authorizes with browser
Go back or Error
Re-authorize with OAuth
Client requests a config
Client wants to go back to the main screen
Multiple profiles found and no profile chosen
Only one profile or profile already chosen
Cancel or Error
Re-authorize
Cancel or Error
Profile has been chosen
Cancel or Error
Config has been obtained
Choose a new server
Get a new configuration
Deregistered
No_Server
Loading_Server
Ask_Location
Chosen_Location
Chosen_Server
Authorized
OAuth_Started
Request_Config
Ask_Profile
Chosen_Profile
Got_Config
 \ No newline at end of file diff --git a/docs/src/gettingstarted/debugging/logging.md b/docs/src/gettingstarted/debugging/logging.md deleted file mode 100644 index 9a7eae2..0000000 --- a/docs/src/gettingstarted/debugging/logging.md +++ /dev/null @@ -1,8 +0,0 @@ -# Logging -As said, logging is used. The logging gets saved in a client-specified directory (see [API](../../api/index.html)). Logging has the following levels: - -- `INFO`: Messages purely for info, these do not indicate any errors. They are merely there for debugging purposes -- `WARNING`: These messages indicate a warning, e.g. non-fatal errors -- `ERROR`: Fatal errors which refuses the app from working correctly - -By default only messages below or equal to `WARNING` are logged (`WARNING`, `ERROR`). However, if the debug variable is set to `True`, all messages will be logged into the log file. -- cgit v1.2.3