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

docs: add links from usage subpage to other subpages (DEV-812) #208

Merged
merged 4 commits into from Jul 26, 2022
Merged
Show file tree
Hide file tree
Changes from 2 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
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
@@ -1,7 +1,7 @@
===REMOVE===

Important! Please follow the new guidelines for naming Pull
Requests: https://docs.dasch.swiss/developers/dsp/contribution/#pull-request-guidelines
Requests: https://docs.dasch.swiss/latest/developers/dsp/contribution/#pull-request-guidelines

> **Note:** If a pull request consists consists of *only one* commit when squash-merging it to main, the commit message will *not* be correct. In this case you have to manually ensure that the commit message is identical to the PR title, not the commit that the PR consists of.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -92,7 +92,7 @@ For formatting Markdown files (*.md) we use the default styling configuration pr

## Publishing
Publishing is automated with GitHub Actions and should _not_ be done manually. Please follow the
[Pull Request Guidelines](https://docs.dasch.swiss/developers/dsp/contribution/#pull-request-guidelines). If done
[Pull Request Guidelines](https://docs.dasch.swiss/latest/developers/dsp/contribution/#pull-request-guidelines). If done
correctly, when merging a pull request into `main`, the `release-please` action will create or update a pull request for
a release. This pull request will follow semantic versioning and update the change log. Once all desired features are
merged, the release can be executed by merging this release pull request into `main`. This will trigger actions that
Expand Down
2 changes: 1 addition & 1 deletion docs/dsp-tools-information-for-developers.md
Expand Up @@ -68,7 +68,7 @@ For formatting Markdown files (*.md) we use the default styling configuration pr
## Publishing

Publishing is automated with GitHub Actions and should _not_ be done manually. Please follow the
[Pull Request Guidelines](https://docs.dasch.swiss/developers/dsp/contribution/#pull-request-guidelines). If done
[Pull Request Guidelines](https://docs.dasch.swiss/latest/developers/dsp/contribution/#pull-request-guidelines). If done
correctly, when merging a pull request into `main`, the `release-please` action will create or update a pull request for
a release. This pull request will follow semantic versioning and update the change log. Once all desired features are
merged, the release can be executed by merging this release pull request into `main`. This will trigger actions that
Expand Down
8 changes: 4 additions & 4 deletions docs/dsp-tools-xmlupload.md
Expand Up @@ -48,7 +48,7 @@ The `<knora>` element can only contain the following sub-elements:

The DSP server provides access control for each resource and each field of a resource through permissions. For a
thorough explanation of the permission and access system of DSP, see
[DSP permissions](https://docs.knora.org/02-knora-ontologies/knora-base/#permissions).
[DSP permissions](https://docs.dasch.swiss/latest/DSP-API/02-knora-ontologies/knora-base/#permissions).

It is optional to define permissions in the XML. If not defined, default permissions are applied, so that only project and
system administrators can view and edit resources. All other users have no rights at all, not even view or restricted view permissions.
Expand Down Expand Up @@ -662,7 +662,7 @@ The `<text>` element has the following attributes:
- `encoding`: either "utf8" or "xml" (required)
- `utf8`: The element describes a simple text without markup. The text is a simple UTF-8 string.
- `xml`: The element describes a complex text containing markup. It must follow the XML format as defined by the
[DSP standard mapping](https://docs.knora.org/03-apis/api-v1/xml-to-standoff-mapping/).
[DSP standard mapping](https://docs.dasch.swiss/latest/DSP-API/03-apis/api-v2/xml-to-standoff-mapping/).
- `permissions`: Permission ID (optional, but if omitted, users who are lower than a `ProjectAdmin` have no permissions at all, not even view rights)
- `comment`: a comment for this specific value (optional)

Expand All @@ -689,7 +689,7 @@ whitespaces will be taken into the text field as they are.
#### Text with markup (XML)

dsp-tools assumes that for markup (standoff markup), the
[DSP standard mapping](https://docs.knora.org/03-apis/api-v1/xml-to-standoff-mapping/) is used (custom mapping is not yet
[DSP standard mapping](https://docs.dasch.swiss/latest/DSP-API/03-apis/api-v2/xml-to-standoff-mapping/) is used (custom mapping is not yet
implemented).

Example of a text containing a link to another resource:
Expand Down Expand Up @@ -921,7 +921,7 @@ To do an incremental XML upload, one of the following procedures is recommended.
shortcode="0001"
default-ontology="anything">

<!-- permissions: see https://docs.dasch.swiss/DSP-API/05-internals/design/api-admin/administration/#permissions -->
<!-- permissions: see https://docs.dasch.swiss/latest/DSP-API/02-knora-ontologies/knora-base/#permissions -->
<permissions id="res-default">
<allow group="UnknownUser">V</allow>
<allow group="KnownUser">V</allow>
Expand Down
2 changes: 1 addition & 1 deletion testdata/test-data.xml
Expand Up @@ -6,7 +6,7 @@
shortcode="4123"
default-ontology="testonto">

<!-- permissions: see https://docs.dasch.swiss/DSP-API/05-internals/design/api-admin/administration/#permissions -->
<!-- permissions: see https://docs.dasch.swiss/latest/DSP-API/02-knora-ontologies/knora-base/#permissions -->
<permissions id="res-default">
<allow group="UnknownUser">RV</allow>
<allow group="KnownUser">V</allow>
Expand Down
2 changes: 1 addition & 1 deletion testdata/test-id2iri-data.xml
Expand Up @@ -6,7 +6,7 @@
shortcode="4123"
default-ontology="testonto">

<!-- :permissions see https://docs.dasch.swiss/DSP-API/05-internals/design/api-admin/administration/#permissions -->
<!-- :permissions see https://docs.dasch.swiss/latest/DSP-API/02-knora-ontologies/knora-base/#permissions -->
<permissions id="res-default">
<allow group="UnknownUser">RV</allow>
<allow group="KnownUser">V</allow>
Expand Down