Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): fix dead links in docs #1492

Merged
merged 5 commits into from
Feb 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# DaSCH Applications and Libraries Monorepo

[![Github](https://img.shields.io/github/v/tag/dasch-swiss/dsp-app?include_prereleases&label=Github%20tag)](https://github.com/dasch-swiss/dsp-app)
[![Github](https://img.shields.io/github/v/tag/dasch-swiss/dsp-app?include_prereleases&label=Github%20tag)](https://github.com/dasch-swiss/dsp-das)
[![Docker](https://img.shields.io/docker/v/daschswiss/dsp-app?label=Docker%20image)](https://hub.docker.com/r/daschswiss/dsp-app)
[![CI](https://github.com/dasch-swiss/dsp-app/workflows/CI/badge.svg)](https://github.com/dasch-swiss/dsp-app/actions?query=workflow%3ACI)
[![CI](https://github.com/dasch-swiss/dsp-das/workflows/CI/badge.svg)](https://github.com/dasch-swiss/dsp-das/actions?query=workflow%3ACI)

This monorepo host different applications and libraries of the DaSCH Service Platform.

Expand Down Expand Up @@ -96,9 +96,9 @@ The most common commands are defined in `package.json`.
## Contribution

If you would like to contribute to the development of the DSP-APP alongside us,
please consult the [general DSP contribution guidelines](https://docs.dasch.swiss/latest/developers/dsp/contribution/).
please consult the [general DSP contribution guidelines](https://docs.dasch.swiss/latest/developers/contribution/).

### Documentation / User guidelines

We built the user guidelines and developer documentation with [MkDocs](https://www.mkdocs.org/).
Get more information in the appropriate [README](https://github.com/dasch-swiss/dsp-app/blob/main/docs/README.md).
Get more information in the appropriate [README](https://github.com/dasch-swiss/dsp-app/blob/main/docs/contribution/docs-documentation.md).
7 changes: 1 addition & 6 deletions apps/dsp-app/src/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,7 @@
<link rel="icon" type="image/x-icon" href="./favicon.ico" />

<!-- Fathom - beautiful, simple website analytics -->
<script
src="https://cdn.usefathom.com/script.js"
data-spa="auto"
data-site="IMXRBKAX"
data-include-domains="admin.dasch.swiss"
defer></script>
<script src="https://cdn.usefathom.com/script.js" data-spa="auto" data-site="IMXRBKAX" defer></script>
<!-- / Fathom -->

<!-- ReleaseNotes injection -->
Expand Down
2 changes: 1 addition & 1 deletion docs/contribution/docs-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The documentation consists of three main topics with subordinate themes:

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/latest/developers/dsp/contribution/)
- Index = How to contribute incl. link to the [general DSP contribution guidelines](https://docs.dasch.swiss/latest/developers/contribution/)
- Release Notes = Contains the CHANGELOG file of DSP-APP

Images like screenshots and so on have to be stored in `assets/images`.
Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/data/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ DSP offers a full-text search that searches through all text values and labels o
It returns data that matches the search conditions.
By default, the search is performed in all projects stored in DSP. However, it is possible to filter by project using the "Filter by project" menu on the left side of the search bar.

![Filter your full-text search by specific project](../../assets/images/search-fulltext-filterByProject.png)*<https://admin.dasch.swiss> - Search 1: Search in one specific project or all projects*
![Filter your full-text search by specific project](../../assets/images/search-fulltext-filterByProject.png)*<https://app.dasch.swiss> - Search 1: Search in one specific project or all projects*

When clicking on the search bar, the search history panel is displayed. The last **10** searches are registered. Click on one search item to perform the same full-text search again. It is also possible to clear the search history list (*Clear list* button at the bottom of the panel or the *x* at the end of each line).

Expand Down Expand Up @@ -143,6 +143,6 @@ 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 work.

![Expert search is a text area in which you can create Gravsearch queries.](../../assets/images/search-expert.png)*<https://admin.dasch.swiss> - 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://app.dasch.swiss> - 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.dasch.swiss/latest/DSP-API/03-endpoints/api-v2/query-language/)
2 changes: 1 addition & 1 deletion docs/user-guide/index.md
Original file line number Diff line number Diff line change
@@ -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 **[admin.dasch.swiss](https://admin.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 **[app.dasch.swiss](https://app.dasch.swiss)**.

---

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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

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

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

Expand All @@ -16,7 +16,7 @@ The list of your projects is accessible from here, click on one project to get m

As a matter of security, it is strongly recommended to update your password at least once a year. On 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://admin.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://app.dasch.swiss/account> - Update your password and deactivate your user account.*

&#9888;
You can delete (deactivate) your own user account. However, only a system administrator will be able to reactivate it.