Skip to content

Commit

Permalink
docs: added documentation for restricted records
Browse files Browse the repository at this point in the history
  • Loading branch information
TLGINO authored and fenekku committed Oct 17, 2024
1 parent e60dc08 commit d45f40b
Show file tree
Hide file tree
Showing 5 changed files with 22 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.
9 changes: 9 additions & 0 deletions docs/features/features-walk-through/metadata_only.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Metadata-only records

A metadata-only record is a record that contains only descriptive metadata, and no associated files. These types of records can be useful in cases where the resource does not have a corresponding digital object or its files are hosted elsewhere.

The site administrator can choose to enable or disable the creation of metadata-only records. For more on that, see [this section](../../customize/metadata_only.md).

To mark a record as metadata-only, simply select the "Metadata-only record" checkbox when creating a new record:

![Setting Metadata only](./img/meta_data_only.png)
11 changes: 11 additions & 0 deletions docs/features/features-walk-through/restricted_records.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Restricted records

A record can be marked as restricted in order to restrict its access to specific users. This is useful for example to share a record with a colleague or team before making it public.

## Setting a record to be restricted

When creating or editing a record, click the "Restricted" checkbox under "Full record" in the "Visibility" section of the form to make the entire record -metadata and files- restricted:

![Visibility Options](./img/visibility_options.png)

To **only** make the files restricted, click the "Restricted" checkbox under "Files only" in the "Visibility" section.
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ nav:
- Site banners: "features/features-walk-through/banners.md"
- Notifications: "features/features-walk-through/notifications.md"
- Access requests: "features/features-walk-through/access_requests.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 d45f40b

Please sign in to comment.