Skip to content
This repository was archived by the owner on Aug 18, 2020. It is now read-only.

English fix #5

Merged
merged 25 commits into from
Aug 11, 2019
Merged
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fixed typos and improved usage/Using-the-GUI.md
  • Loading branch information
DragonCoder01 committed Jul 31, 2019
commit 711c43ed438fb7f2d6f4695cae6ceea2bd6d61ad
28 changes: 14 additions & 14 deletions usage/Using-the-GUI.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,45 @@
The GUI for chatoverflow is still in development.
Thats why whe have the **Better REPL**, an easy-to-use one-page dashboard, where everything can be controlled.
That's why whe have the **Better REPL**, an easy-to-use one-page dashboard, where everything can be controlled.

## Starting the Better REPL
When using the GUI for the first time use the `[Advanced]` run configuration that packages the gui into the chatoverflow jar.
For all further runs you may use the `[Simple]` run configuration which is way faster.

Once the framework is running open http://localhost:2400/, wait for the server status to display `Connected!` and click on `OPEN BETTER REPL`.
Once the framework is running open http://localhost:2400/ in a browser and wait for the server status to display `Connected!`. Now click on `OPEN BETTER REPL`.

![](/img/usage/login.png)

When running for the first time enter a password that you want to use for securing your credentials and click on `REGISTER`.
If you have already registered, use your password to login.
If the login was successful the gui will display the authentication key for that session.
If you already are registered, use your password to login.
If the login was successful the gui will display the authentication key for this session.

## Creating a plugin instance
Before running a plugin you have to create the plugin instance.
Before running a plugin you have to create a plugin instance.
All available plugins are listed under `Plugin types`.
Add more plugins by putting the plugin Jar files into the plugins folder.
Add more plugins by putting the plugin `.jar` files into the plugins folder.

![](/img/usage/plugin-types.png)

Enter the plugin name and the author of the plugin and give the instance a name (whatever you like), the click on `CREATE`:
Enter the plugin name as well as the author of the plugin and give the instance a name (whatever you like), then click on `CREATE`:

![](/img/usage/create-plugin.png)

The plugin instance should now list under `Plugin instances`:
The plugin instance should now be listed under `Plugin instances`:

![](/img/usage/plugin-instances.png)

You can use the pen to copy an instances name.
There are buttons that allow you to `START` / `STOP` a instance, to show its log (if running) or requirements and a button to `DELETE` the instance (just make sure to stop it before deleting it).
You can use the pen to copy the name of an instance.
There are buttons that allow you to `START` / `STOP` an instance, to show its log (if running) or requirements and a button to `DELETE` the instance (just make sure to stop it before deleting it).

## Setting plugin requirements
Before you can start a plugin you need to set its requirements.
A plugin can require a lot of thins: Strings, Inputs or Outputs are the most often used.
A plugin can require a lot of things, for example Strings, Inputs or Outputs.
To view all requirements of a plugin enter the instance name and click on `SHOW REQUIREMENTS`.

![](/img/usage/plugin-requirements.png)
You see that each requirement has a type and needs a value.
You see which requirements are already set and which ones are optional (don't need to be set to start the plugin).
To set/change the value click on the blue pen, enter the requirement value and click on `PUT`.
You see which requirements are already set and which ones are optional.
To set or change the value click on the blue pen, enter the required value and click on `PUT`.

![](/img/usage/change-requirement.png)

Expand All @@ -51,7 +51,7 @@ To add a connector use whatever source identifier you like, specify the connecto
![](/img/usage/create-connector.png)

## Set credentials
Every connector needs you to set the credentials for that service.
Every connector requires you to set the credentials for that service.
Use the blue pen to copy the identifier and the type to the connector and then use the manage credentials field to set key and value of the credentials.

![](/img/usage/credentials.png)
Expand Down