Skip to content

Commit

Permalink
docs: fix dead links and replace screenshots in project (#460)
Browse files Browse the repository at this point in the history
* docs: fix dead links

* docs(project): replace image
  • Loading branch information
kilchenmann committed Jun 10, 2021
1 parent 09259f1 commit a13b8ba
Show file tree
Hide file tree
Showing 11 changed files with 11 additions and 11 deletions.
Binary file added docs/assets/images/dashboard.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/images/data-model-add-property.png
Binary file not shown.
Binary file removed docs/assets/images/data-model-add-source.png
Binary file not shown.
Binary file removed docs/assets/images/data-model-edit-source.png
Binary file not shown.
Binary file removed docs/assets/images/data-model-init.png
Binary file not shown.
Binary file removed docs/assets/images/project-list.png
Binary file not shown.
6 changes: 3 additions & 3 deletions docs/how-to-use/data.md
Expand Up @@ -33,7 +33,7 @@ DSP-APP offers the possibility to the user to search in 3 different ways: **full

Full text search performs queries including one or more terms or phrases, and returns data that matches search conditions. By default, the search is performed in all projects stored in DSP. However, it is possible to filter by project using the menu "Filter by project" on the left side of the search bar.

![Filter your full text search by specific project](../assets/images/search-fulltext-filterByProject.png)*https://app2.dasch.swiss - Search 1: Full text search*
![Filter your full text search by specific project](../assets/images/search-fulltext-filterByProject.png)*<https://admin.dasch.swiss> - Search 1: Full text search*

When clicking on the search bar, the search history panel is displayed. The **10** last searches are registered. It is also possible to clear the search history list (*Clear list* button at the bottom of the panel).

Expand All @@ -54,7 +54,7 @@ The advanced search allows you to filter by project, by source type, or by the m

In addition, for a metadata field that is connected to another source type, it's possible to filter by this second source type.

![Search 2: Advanced search offers many filter combinations and is a powerful search tool.](../assets/images/search-advanced.png)*https://app2.dasch.swiss/search/advanced - Search 2: Advanced search offers many filter combinations and is a powerful search tool.*
![Search 2: Advanced search offers many filter combinations and is a powerful search tool.](../assets/images/search-advanced.png)*<https://admin.dasch.swiss/search/advanced> - Search 2: Advanced search offers many filter combinations and is a powerful search tool.*

Currently, it is possible to search for only **one** source.

Expand All @@ -68,7 +68,7 @@ The expert search can be more powerful than the advanced search, but requires kn

**For example**: you could search for a page in a manuscript that contains a certain element and also mentions a person, who lived in the same country as another person, who is the author of another author.

![Expert search is a text area in which you can create Gravsearch queries.](../assets/images/search-expert.png)*https://app2.dasch.swiss/search/expert - Search 3: Expert search is a text area in which you can create Gravsearch queries. Here is the default example you can find in the app.*
![Expert search is a text area in which you can create Gravsearch queries.](../assets/images/search-expert.png)*<https://admin.dasch.swiss/search/expert> - Search 3: Expert search is a text area in which you can create Gravsearch queries. Here is the default example you can find in the app.*

To learn Gravsearch, go to the DSP-API documentation [&rarr; Gravsearch](https://docs-api.dasch.swiss/03-apis/api-v2/query-language/)

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-use/index.md
@@ -1,6 +1,6 @@
# User Guide

This is the documentation for the generic DSP Web Application of the Data and Service Center for the Humanities DaSCH. You can reach the app on **[app2.dasch.swiss](https://app2.dasch.swiss)**.
This is the documentation for the generic DSP Web Application of the Data and Service Center for the Humanities DaSCH. You can reach the app on **[admin.dasch.swiss](https://admin.dasch.swiss)**.

---

Expand Down
4 changes: 2 additions & 2 deletions docs/how-to-use/project.md
Expand Up @@ -4,7 +4,7 @@

Once you are [logged in](/user-guide/#login), the dashboard displays the list of your project(s). If you are a project administrator or a system administrator, you can edit the project information or archive your project from the project menu. Archived projects are stored in a list on your dashboard and they can be "reactivated" at any time.

![Project list and project menu](../assets/images/project-list.png)*<https://admin.dasch.swiss/dashboard> - By clicking on the project name, you get access to the full project information.*
![Project list and project menu](../assets/images/dashboard.png)*<https://admin.dasch.swiss/dashboard> - By clicking on the project name, you get access to the full project information.*

System administrator can create your new research project. Essential information are required such as the project name, a short project description and institution information.

Expand Down Expand Up @@ -135,7 +135,7 @@ E.g., For the metadata "Photographer" in resource type "Photograph", you should
Projects often need to define lists or hierarchies of categories that can be assigned to many different sources. Lists can be created by project admin and system admin.
![Project lists](../assets/images/project-lists.png)*https://app2.dasch.swiss/project/0803/lists - Project lists: create a new list, add items by selecting the language and enter the corresponding value, repeat for each translation and press the + sign to create another item to the same level.*
![Project lists](../assets/images/project-lists.png)*<https://admin.dasch.swiss/project/0803/lists> - Project lists: create a new list, add items by selecting the language and enter the corresponding value, repeat for each translation and press the + sign to create another item to the same level.*
**The edition of items and child items will be implemented in a later version.**
-->
8 changes: 4 additions & 4 deletions docs/how-to-use/user.md
@@ -1,14 +1,14 @@
# User Administration
# User Profile

![Get access to your user profile and more](../assets/images/usermenu-to-userprofile.png)*https://app2.dasch.swiss/dashboard - Get access to your user profile, collections and account from the main user menu.*
![Get access to your user profile and more](../assets/images/usermenu-to-userprofile.png)*<https://admin.dasch.swiss/dashboard> - Get access to your user profile, collections and account from the main user menu.*

---

## Your user profile and projects

To change your personal information as well as your default language used by the interface, you can edit your profile clicking *Edit*. Currently, the avatar image comes from gravatar.com (go on their [website](http://en.gravatar.com/) to register if you want your customized user photo).

![Get access to your user profile and more](../assets/images/user-profile.png)*https://app2.dasch.swiss/projects - Overview of your user profile and your projects.*
![Get access to your user profile and more](../assets/images/user-profile.png)*<https://admin.dasch.swiss/projects> - Overview of your user profile and your projects.*

The list of your projects is accessible, click on one project to get more information about it. As project admin, you can also edit or archive your projects, and as system admin, you can additionally create new project on this page.

Expand All @@ -28,7 +28,7 @@ You will be able to store collections of sources or specific searches to work wi

As a matter of security, it is strongly recommended to update your password at least once a year. In your account page, you can update your password.

![Get access to the user account where the user can reset its password and deactivate its own account](../assets/images/user-account.png)*https://app2.test.dasch.swiss/account - Update your password and deactivate your user account.*
![Get access to the user account where the user can reset its password and deactivate its own account](../assets/images/user-account.png)*<https://admin.dasch.swiss/account> - Update your password and deactivate your user account.*

&#9888;
You can delete (deactivate) your own user account. Only a system administrator will be able to reactivate it.
2 changes: 1 addition & 1 deletion mkdocs.yml
Expand Up @@ -10,8 +10,8 @@ nav:
- User Guide:
- Introduction: how-to-use/index.md
- Project Administration: how-to-use/project.md
- User Administration: how-to-use/user.md
- System Administration: how-to-use/system.md
- User Profile: how-to-use/user.md
# - Data Management: how-to-use/data.md
# - Publication: how-to-use/publication.md
- Contribution:
Expand Down

0 comments on commit a13b8ba

Please sign in to comment.