docs: refactor documentation and set correct links (#467)

dasch-swiss · Jun 22, 2021 · cbeb274 · cbeb274
1 parent 32cd462
commit cbeb274
Show file tree

Hide file tree

Showing 13 changed files with 20 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -20,13 +20,11 @@ DSP-APP is [free software](http://www.gnu.org/philosophy/free-sw.en.html), relea
 
 ### User guide
 
-➡ [for current deployed version](https://docs.dasch.swiss/user-guide/)
-
-➡ [for development version](https://dasch-swiss.github.io/dsp-app/how-to-use)
+➡ [for latest released version](https://docs.dasch.swiss/dsp-app/user-guide/)
 
 ### Developer docs
 
-➡ [for developers](https://dasch-swiss.github.io/dsp-app/how-to-contribute)
+➡ [for developers](https://docs.dasch.swiss/dsp-app/contribution)
 
 ## Contribution
 

diff --git a/docs/README.md b/docs/README.md
@@ -12,13 +12,13 @@ If you would like to add your own contributions to the docs, please read the fol
 The documentation consists of three main topics with subordinate themes:
 
 1. **index** contains all information about the DSP-APP
-1. **how-to-use** contains the DSP-APP user guide
+1. **user-guide** contains the DSP-APP user guide
     - Index = Introduction: All about login, registration and DSP APP information in general.
     - Project = All about project administration; part of DSP-ADMIN
     - User = All about user administration; part of DSP-ADMIN
     - System = All about system administration; part of DSP-ADMIN
     - Data = All about data management; part of VRE. In the current DSP-APP ADMIN version it's commented out
-1. **how-to-contribute** contains all information for people who wants to contribute to DSP-APP
+1. **contribution** contains all information for people who wants to contribute to DSP-APP
     - Index = How to contribute incl. link to the general DSP contribution guidelines (<https://docs.dasch.swiss/developers/dsp/contribution/>)
     - Release Notes = Contains the CHANGELOG file of DSP-APP
 

diff --git a/docs/how-to-contribute/docs-documentation.md → docs/contribution/docs-documentation.md b/docs/how-to-contribute/docs-documentation.md → docs/contribution/docs-documentation.md
diff --git a/docs/how-to-contribute/index.md → docs/contribution/index.md b/docs/how-to-contribute/index.md → docs/contribution/index.md
diff --git a/docs/how-to-contribute/release-notes.md → docs/contribution/release-notes.md b/docs/how-to-contribute/release-notes.md → docs/contribution/release-notes.md
diff --git a/docs/how-to-use/data.md → docs/user-guide/data.md b/docs/how-to-use/data.md → docs/user-guide/data.md
@@ -87,6 +87,7 @@ It is not possible yet to sort or order by criteria when searching with the full
 ---
 
 ### Grid list: Lighttable
+&#9888; *NOT YET IMPLEMENTED*
 
 The results of the search are displayed in a grid list with a big preview. You can select one result at a time to get more information.
 

diff --git a/docs/how-to-use/index.md → docs/user-guide/index.md b/docs/how-to-use/index.md → docs/user-guide/index.md
diff --git a/docs/how-to-use/project.md → docs/user-guide/project.md b/docs/how-to-use/project.md → docs/user-guide/project.md
diff --git a/docs/how-to-use/publication.md → docs/user-guide/publication.md b/docs/how-to-use/publication.md → docs/user-guide/publication.md
diff --git a/docs/how-to-use/system.md → docs/user-guide/system.md b/docs/how-to-use/system.md → docs/user-guide/system.md
diff --git a/docs/how-to-use/user.md → docs/user-guide/user.md b/docs/how-to-use/user.md → docs/user-guide/user.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -11,13 +11,13 @@ nav:
     - Introduction: how-to-use/index.md
     - Project Administration: how-to-use/project.md
     - System Administration: how-to-use/system.md
+    - Data Management: how-to-use/data.md
     - User Profile: how-to-use/user.md
-    # - Data Management: how-to-use/data.md
     # - Publication: how-to-use/publication.md
   - Contribution:
-    - How to contribute: how-to-contribute/index.md
-    - Docs Documentation: how-to-contribute/docs-documentation.md
-    - Release Notes: how-to-contribute/release-notes.md
+    - How to contribute: contribution/index.md
+    - Docs Documentation: contribution/docs-documentation.md
+    - Release Notes: contribution/release-notes.md
 
 plugins:
     - include-markdown

diff --git a/src/app/main/help/help.component.ts b/src/app/main/help/help.component.ts
@@ -25,23 +25,23 @@ export class HelpComponent implements OnInit {
     docs: GridItem[] = [
         {
             icon: 'assignment',
-            title: 'Project management',
-            text: 'Read more about project administration, project members and how to define a data model.',
-            url: 'https://docs.dasch.swiss/user-guide/project',
+            title: 'Project administration',
+            text: 'Read more about project administration and how to manage project members.',
+            url: 'https://docs.dasch.swiss/dsp-app/user-guide/project',
             urlText: 'Open Documentation'
         },
         {
-            icon: 'edit',
-            title: 'Research tools',
-            text: 'NOT FULLY IMPLEMENTED - Get more information about data handling, search methods and how to use the research tools.',
-            url: 'https://docs.dasch.swiss/user-guide/data',
+            icon: 'bubble_chart',
+            title: 'Data model creation',
+            text: 'Find everything about data modelling and how to setup the project database.',
+            url: 'https://docs.dasch.swiss/dsp-app/user-guide/project/#data-model',
             urlText: 'Open Documentation'
         },
         {
-            icon: 'web',
-            title: 'Publication',
-            text: 'NOT YET IMPLEMENTED',
-            url: 'https://docs.dasch.swiss/user-guide/publication',
+            icon: 'image_search',
+            title: 'Research tools',
+            text: 'Get more information about data handling, search methods and how to use the research tools.',
+            url: 'https://docs.dasch.swiss/dsp-app/user-guide/',
             urlText: 'Open Documentation'
         }
     ];