Skip to content

Commit

Permalink
docs: added documentation for restricted records
Browse files Browse the repository at this point in the history
 * closes #532
  • Loading branch information
TLGINO committed Jun 30, 2023
1 parent caf205e commit 3de66c4
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions docs/features/features-walk-through/metadata_only.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Metadata-only records


A metadata-only record is a record that contains only descriptive metadata, without any associated files or content. These types of records can be useful in cases where you want to provide metadata for a resource that does not have a corresponding digital object or content file.

The site administrator can choose to enable and disable the creation of metadata-only records.


To mark a record as metadata-only, simply select "metadata-only" when creating a new record:
![Setting Metadata only](./img/meta_data_only.png)
22 changes: 22 additions & 0 deletions docs/features/features-walk-through/restricted_records.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Restricted records

A record can be marked as restricted in order to grant access to it only to a specific group of users or organisations. This is useful for example if you want to share a record with a colleague or team before making it public.

## Creating a restricted record

When creating a new record, you can mark it as restricted by clicking the "Restricted" checkbox in the "Visibility" section of the form:

![Creating restricted](./img/restricted_record_select.png)


## Modifying an existing record

You can also edit an existing record and mark it as restricted. To do this, go to the record's details page and click the "Edit" button in the top right corner:
![Editing record](./img/restricted_record_edit.png)


Next, in the visibility section of the form, check the "Restricted" checkbox:

Note: You can either mark the **whole** record as restricted or **only** the files.

![Setting restricted](./img/restricted_record_modify.png)
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ nav:
- Features walk-through:
- Features overview: "features/features-walk-through/index.md"
- Site banners: "features/features-walk-through/banners.md"
- Restricted records: "features/features-walk-through/restricted_records.md"
- Metadata-only records: "features/features-walk-through/metadata_only.md"
- Install:
- Quick start: "install/index.md"
- System requirements: "install/requirements.md"
Expand Down

0 comments on commit 3de66c4

Please sign in to comment.