Skip to content

Commit dab9859

Browse files
pettanjpettanj
committed
Add better markdown description
1 parent bcf4763 commit dab9859

1 file changed

Lines changed: 30 additions & 52 deletions

File tree

‎ESSArch_TA/frontend/static/frontend/markdown_example.md‎

Lines changed: 30 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,42 @@
1-
# User guide - example
1+
# **User guide**
22

33
## Table of Contents
44

5-
- [Level 1](level-1)
6-
- [Level 2 item 1](level-2-item-1)
7-
- [Level 2 item 2](level-2-item-2)
8-
- [Level 2 item 3](level-2-item-3)
9-
- [Level 3 item 1](level-3-item-1)
10-
- [Level 3 item 2](level-3-item-2)
11-
- [Level 3 item 3](level-3-item-3)
5+
- [Introduction ESSArch](introduction-essarch)
6+
- [Installation](installation)
7+
- [ESSArch Tools for Producer (ETP)](essarch-tools-for-producer)
8+
- [List view](list-view)
9+
- [Reception](reception)
10+
- [Transfer SIP](transfer-sip)
1211

13-
## Level 1
12+
## Introduction ESSArch
13+
ESSArch is an open source archival solution compliant to the OAIS ISO-standard. ESSArch consist of software components that provide functionality for Pre-Ingest, Ingest, Preservation, Access, Data Management, Administration and Management. ESSArch has been developed together with the National Archives of Sweden and Norway. Every software component of ESSArch can be used individually and also be easily integrated together to provide overall functionality for producers, archivists and consumers. ESSArch consist of ETP, ETA and EPP, each individually created to provide tools for long-term digital preservation.
1414

15-
Praesent iaculis posuere enim, in posuere velit consequat et.
16-
Nullam gravida erat in nisi maximus pulvinar. Nullam porttitor cursus odio consequat vehicula.
17-
Pellentesque eget mauris et nulla porta dapibus ut in justo. Sed eget nibh sit amet elit cursus
15+
* ESSArch Tools for Producer (ETP) is used to prepare IPs, to create SIPs and to submit SIPs to archival institution
16+
* ESSArch Tools for Archivists (ETA) is used to receive SIPs and to prepare SIPs for ingest into the preservation platform
17+
* ESSArch Preservation Platform (EPP) is used to ingest SIPs, perform SIP2AIP, store AIPs in different archival storage according to storage methods, provide search and access functionality for consumers
1818

19-
imperdiet ac id lorem. Pellentesque vel maximus nisl. Pellentesque consectetur blandit libero sed suscipit.
20-
Nulla vitae erat dignissim, maximus sem viverra, venenatis massa. Pellentesque varius mollis sapien eget
21-
ultricies. Praesent sed purus tempor massa dignissim gravida. Donec laoreet arcu ac tempus rutrum.
22-
### Level 2 item 1
2319

24-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus at.
25-
![initialise SIP creation](static/frontend/img/prepare_ip.png)
20+
## Installation
21+
All of the ESSArch tools can be downloaded from [github](https://github.com/ESSolutions). Installation procedure is described on the ESSArch [doc site](http://doc.essarch.org/).
2622

27-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus at.
2823

29-
### Level 2 item 2
24+
## List view
25+
The so called list view is the table of IP's that is present in all views in eta(Reception and Transfer SIP).
26+
The IP's that are listed in this view are always relevant to the current view(for example, already created SIP's are no longer visble in the Create SIP view).
3027

31-
Praesent iaculis posuere enim, in posuere velit consequat et.
32-
Nullam gravida erat in nisi maximus pulvinar. Nullam porttitor cursus odio consequat vehicula.
33-
Pellentesque eget mauris et nulla porta dapibus ut in justo. Sed eget nibh sit amet elit cursus
28+
The list view has a couple of important functions built in which will be described below.
29+
* The main funcitonality of a view, such as Receive SIP, is accessed by clicking the IP label column. These are described in the sections for the views.
30+
* Clicking the state column will show all steps and tasks for an IP. This view has information about task and step outcome, progress and sub steps/tasks.
31+
Click on a step or a task to get a page with more information about the step/task. This is very useful if a step/task fails because the user can access an error traceback which will help
32+
when trying to find out where things went wrong.
33+
* The Events column will show a list of all events for an IP. A user can add new events.
34+
* Delete IP. A user that is either responsible or has the permission to delete can delete it.
3435

35-
![adding files](static/frontend/img/create_sip.png)
36-
37-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam porttitor ultrices placerat. Donec ultrices sed est ac tempor. Vestibulum justo.
38-
39-
![creating first representation](static/frontend/img/submit_sip.png)
40-
41-
42-
### Level 2 item 3
43-
44-
* Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam porttitor ultrices placerat. Donec ultrices sed est ac tempor. Vestibulum justo.
45-
* Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam porttitor ultrices placerat. Donec ultrices sed est ac tempor. Vestibulum justo.
46-
* Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam porttitor ultrices placerat. Donec ultrices sed est ac tempor. Vestibulum justo.
47-
48-
#### Level 3 item 1
49-
50-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam porttitor ultrices placerat. Donec ultrices sed est ac tempor. Vestibulum justo.
51-
#### Level 3 item 2
52-
53-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam porttitor ultrices placerat. Donec ultrices sed est ac tempor. Vestibulum justo.
54-
55-
![sip creation task exectuion](static/frontend/img/prepare_ip.png)
56-
57-
58-
#### Level 3 item 3
59-
60-
imperdiet ac id lorem. Pellentesque vel maximus nisl. Pellentesque consectetur blandit libero sed suscipit.
61-
Nulla vitae erat dignissim, maximus sem viverra, venenatis massa. Pellentesque varius mollis sapien eget
62-
ultricies. Praesent sed purus tempor massa dignissim gravida. Donec laoreet arcu ac tempus rutrum.
63-
![active SIP creation processes overview](static/frontend/img/submit_sip.png)
36+
## Reception
37+
When clicking the label column the user can see the Submit description and the file(s) of the ip.
38+
To Receive an IP, check the checkbox at the start of the table row, choose validators, check "Approved to receive" and click "Receive SIP".
6439

40+
## Transfer SIP
41+
Once an IP is received it is visible in the Transfer SIP view.
42+
The purpose of this view, other than inspecting tasks, steps and events, is to just Transfer the SIP, so when clicking the label column check "Approved to transfer" and click "Transfer SIP".

0 commit comments

Comments
 (0)