Skip to content
Snippets Groups Projects
Commit c6a18da1 authored by Menou Lucas's avatar Menou Lucas
Browse files

refactor: re-organize all docs

parent a858eba2
No related branches found
No related tags found
1 merge request!4feat/updating
# Dataset administration
## Dataset settings
## Dataset edition
## Dataset export
docs/img/create_instance.png

39 KiB

docs/img/handle_databases.png

23.9 KiB

docs/img/handle_databases_configuration.png

37.5 KiB

docs/img/import_instance.png

46.2 KiB

docs/img/instance_design.png

89 KiB

docs/img/instance_edition.png

71.4 KiB

docs/img/instance_setting.png

104 KiB

# Instance administration
## Creation and deletion
![create_instance](img/create_instance.png)
## Import and export
Configuring an instance is a lengthy operation.
Copying an instance configuration from a deployed version to a local one is prone to error and not convenient.
ANIS can export and import instances configuration in a `json` file.
### Instance export
If you click in the **instance export (file export)**, you should get a popup proposing the download of the chosen instance configuration via a `json` file.
### Instance import
Say you wish to create a new instance, and you have a `json` configuration file at your disposal.
You can click in the *green card with a plus sign* on the administration portal.
![create_instance](img/create_instance.png)
From there, you can either fill a form that resembles the one offered via **instance edition**.
Or, you can choose the button **Import an instance**, that offers to select a `json` configuration file on click and **Import the new instance**.
![import_instance](img/import_instance.png)
If no error occurs, the new instance should be available for further configuration.
## Instance management
Once an *instance* is created, for a given project, you should configure it.
For the purpose of the explanation, the default instance configuration is detailed here.
### Instance edition
When you click upon the **instance edition (pencil)** button, you should land on a form page as the following.
The form should be self-explanatory, detailing all the main properties of the chosen instance.
Changing the latter configuration, changes the main properties of the chosen instance.
Hence, changes to the latter form should be registered cautiously.
![instance_edition](img/instance_edition.png)
**Note**: once changes completed, don't forget to click in **Update instance information** validation button *at the bottom of the page*, to register the latter.
### Instance design
ANIS offers the possibility to customize the design of each instance, so that each project gets its own characteristics.
Hence, button colors, footers, headers, and tables are customizable.
When you click upon the **instance design (paint palette)** button, you should land on a form page as the following.
The form is lengthy and not explained in detail here.
![instance_design](img/instance_design.png)
The best way to know about all possibilities so far: to try to change a few things and check the result on the [web user interface](web_client.md).
**Note**: once changes completed, don't forget to click in **Update design config information** validation button *at the bottom of the page*, to register the latter.
## Instance settings
If you click in the **instance settings (gear)** button on the administration interface, you should land on a page resembling this one.
![instance_setting](img/instance_setting.png)
### Handle databases
This section explain the database configuration for an instance.
To access datasets in instances, you need to properly configure the connection to a database.
If you click in the button **Handle databases**:
![handle_databases](img/handle_databases.png)
You should land on page resembling this one:
![handle_databases_configuration](img/handle_databases_configuration.png)
Note, that a database named ***Test** is pre-configured with the default
instance. The latter database call on the *db* container configured in the
`docker-compose.yml` stack.
To connect to a database, you need to provide username and network configuration.
If you click in the **Edit** button, you should land on a self-explanatory form to give the latter configuration.
**Note**: one instance can accept more than one database connection, as hinted by the button **New database**. Hence, accessing datasets not stored in the same database instance.
### Webpage in an instance
### Instance group
......@@ -49,37 +49,10 @@ The default instance refers to one anis-client project run in development mode o
On the card menu you can see five buttons, in order:
- **instance settings (gear)**: to configure the instance itself
- **instance edition (pencil)**: to configure the instance intrinsic properties themselves
- **instance design (paint palette)**: to manage the general appearance of the instance
- **instance export (file export)**: to export the instance configuration
- **instance deletion (bin)**: to delete the instance itself, an irreversible operation
- **instance settings (gear)**: to [configure](instance.md#instance-settings) *the datasets and webpages* in the instance
- **instance edition (pencil)**: to [configure](instance.md#instance-edition) the instance *intrinsic properties* themselves
- **instance design (paint palette)**: to [manage](instance.md#instance-design) the *general appearance* of the instance
- **instance export (file export)**: to *[export](instance.md#import-and-export) the instance configuration*
- **instance deletion (bin)**: to *delete the instance itself*, **an irreversible operation**
## Instance settings
### Dataset settings
### Dataset edition
### Dataset export
First of all click on `Projects` on the top menu.
![anis_admin_list_project](img/anis_admin_list_projects.png#center)
On the first tab you can see all available scientific projects.
A scientific project must be linked to a database. To add a new
database you must go to the second tab `Databases`.
![anis_admin_list_databases](img/anis_admin_list_databases.png#center)
Here you see the test database added during the installation of anis-server.
To add a new database, you must click on `new database`. You must then fill in
all the mandatory fields to reference a new database. Attention for the moment
only the postgresql driver has been tested.
## Instance edition
## Instance design
## Instance export
The green + card menu enables to [create](instance.md#creation-and-deletion) a new instance from scratch.
......@@ -9,13 +9,16 @@ nav:
- What is ANIS?: index.md
- Installation: installation.md
- ANIS Configuration Basics:
- Metamodel database: metamodel_database.md
- Server API: server_api.md
- The Metamodel database: metamodel_database.md
- The Server API: server_api.md
- File management: data_management.md
- Authorization management: authorization.md
- The web interface of ANIS:
- Web portal: web_portal.md
- Web client: web_client.md
- Web admin: web_admin.md
- ANIS Scientific API:
- Main Portal: web_portal.md
- Client guide: web_client.md
- Administration guide:
- The administration interface: web_admin.md
- Instance administration: instance.md
- Dataset administration: dataset.md
- The ANIS Scientific API:
- REST API description: data_search.md
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment