Skip to content
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions astro.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ export default defineConfig({
// ],
autogenerate: { directory: "guides" },
},
{
label: "Reference",
autogenerate: { directory: "reference" },
},
],
}),
],
Expand Down
Binary file added src/assets/images/contributor-detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
58 changes: 58 additions & 0 deletions src/content/docs/guides/global-settings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: Global Settings
description: Learn how to edit global settings.
sidebar:
order: 6
---

import { Steps, Badge } from "@astrojs/starlight/components";

## Edit Global Settings

*Global settings apply to your entire Meru instance under your provider account. This is where you can update the site logo, configure controlled vocabularies, customize the theme, and manage global elements such as the footer.*

### Access Global Settings

<Steps>

1. Log in to the Meru Admin.
2. To get to the global settings, go to **Manage** in the main navigation and click on **Global settings**.

<Badge text="Note" variant="note" /> _The global settings are only visible to users with `global_admin` privileges._


3. A drawer will open up with all of the global settings fields.

</Steps>

### Global Settings Fields

- **Provider Name** — The name of your provider or organization.

- **Installation Name** — The name of this specific Meru installation.

- **Logo** — Upload a logo to display across your installation. You can upload a file directly or drag and drop one into the field. See the [image uploading guidelines](/reference/image-guide) for sizing recommendations.

- **Logo Settings** — Choose whether the logo should be displayed with or without the installation name.

- **Installation Home Page Copy** — Text that will appear on the installation’s home page, if the installation has multiple communities.

_**Example:**_
_The [Provider Name] Platform, developed by our partner Cast Iron Coding, ingests content from multiple upstream submission and curation systems such as Janeway, OJS, and DSpace..._

- **Controlled Vocabularies** — A section where you configure controlled vocabularies used across your installation.

- **Contribution Roles** — Select the controlled vocabulary to use for contributor roles. Currently, the only available option is **MARC Relator Codes**.

- **Default Role** — Select the default role to assign to contributors when a role is not explicitly specified. Options include roles such as **Editor**, **Author**, **Voice Actor**, **Storyteller**, and many more.

- **Color Theme** _(required)_ — Sets the app color theme across all communities. Options: **Blue**, **Gray**, or **Cream**.

- **Font Theme** _(required)_ — Sets the app font theme across all communities. Options: **Ilisarniq**, **Switzer**, or **Sentient**, .

- **Suppress External Links** — When enabled, hides external links in metadata.

- **Footer Description** — The footer description displayed at the bottom of your installation’s pages. This field accepts basic markdown.

- **Copyright Statement** — The copyright information displayed in the footer. Example:
**Copyright 2025 Meru**.
3 changes: 3 additions & 0 deletions src/content/docs/guides/harvesting.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Harvesting
description: Learn how to configure sources, mappings, and attempts to harvest external content into Meru.
sidebar:
order: 5
---

import { Aside, Steps, Badge, Card } from "@astrojs/starlight/components";
Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/guides/keycloak.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Keycloak
description: Manage users, roles, and authentication settings in Keycloak for Meru access and administration.
sidebar:
order: 2
---

import { Steps } from "@astrojs/starlight/components";
Expand Down
258 changes: 258 additions & 0 deletions src/content/docs/guides/users-contributers.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,258 @@
---
title: Users & Contributors
description: Learn how to manage users and contributors.
sidebar:
order: 4
---

import { Steps, Badge } from "@astrojs/starlight/components";

## Manage Users

*Creating and removing users, as well as assigning administation privileges, is handled through the [Keycloak user dashboard](/guides/keycloak#creating-users), or users can register their own account directly from the Meru login screen. This section focuses on managing users after they've been created—resetting passwords, updating user details, and managing associated communities, collections, or items.*

### Access User List

<Steps>

1. Log in to the Meru Admin.
2. To get to the user list, go to **Manage** in the main navigation and click on **Users**.

<Badge text="Note" variant="note" /> _Only those with `global_admin` privileges can edit user accounts._


3. The main page will show a list of all users in your Meru instance. You’ll see each user's name, email address, admin status, and creation date.

</Steps>

### Reset a User Password

<Steps>

1. From the main user list, click on the name of the user whose password you’d like to reset.
2. In the top right of the user dashboard, click the **Reset password 🔗** button.
3. A modal will appear confirming that a password reset email will be sent to the user. Click **Send email**.

</Steps>

### Update User Details

<Steps>

1. From the main user list, click on the name of the user whose details you’d like to update.
2. In the left side of the user dashboard, make sure the **Details** tab is selected.
3. Update the user’s **first name**, **last name**, or **email**.
4. Upload a user avatar. See the [image uploading guidelines](/reference/image-guide) for sizing recommendations.

</Steps>

### Manage Community Access

<Steps>

1. From the main user list, click on the name of the user whose communities you’d like to update.
2. In the left side of the user dashboard, make sure the **Communities** tab is selected.

</Steps>

#### Add New Community Access

<Steps>

1. At the top right of the page, underneath the **Reset password 🔗** button, click on **Add Community +**.
2. In the drawer, select an existing community and assign a role for the user within that community.
3. Click **Save**.

</Steps>

#### Update an Existing Community Access

<Steps>

1. Hover over the community name that you would like to update.
2. To remove the community, click on the button with the trash icon, and click **Delete**.
3. To update the role for the user within that community, click on the button with the pencil icon. Select the new role from the dropdown menu and click **Save**.
4. Click on the community name to navigate to that community's detail page.

</Steps>

### Manage Collection Access

<Steps>

1. From the main user list, click on the name of the user whose collections you’d like to update.
2. In the left side of the user dashboard, make sure the **Collections** tab is selected.

</Steps>

#### Add New Collection Access

<Steps>

1. At the top right of the page, underneath the **Reset password 🔗** button, click on **Add Collection +**.
2. In the drawer, select an existing collection and assign a role for the user within that collection.
3. Click **Save**.

</Steps>

#### Update an Existing Collection Access

<Steps>

1. Hover over the collection name that you would like to update.
2. To remove the collection access, click on the button with the trash icon, and click **Delete**.
3. To update the role for the user within that collection, click on the button with the pencil icon. Select the new role from the dropdown menu and click **Save**.
4. Click on the collection name to navigate to that collection's detail page.

</Steps>

---

### Manage Items Access

<Steps>

1. From the main user list, click on the name of the user whose items you’d like to update.
2. In the left side of the user dashboard, make sure the **Items** tab is selected.

</Steps>

#### Add New Item Access

<Steps>

1. At the top right of the page, underneath the **Reset password 🔗** button, click on **Add Item +**.
2. In the drawer, select an existing item and assign a role for the user within that item.
3. Click **Save**.

</Steps>

#### Update an Existing Item Access

<Steps>

1. Hover over the item name that you would like to update.
2. To remove the item access, click on the button with the trash icon, and click **Delete**.
3. To update the role for the user within that item, click on the button with the pencil icon. Select the new role from the dropdown menu and click **Save**.
4. Click on the item name to navigate to that item's detail page.

</Steps>

## Manage Contributors

*In most cases, contributors are automatically created via the harvesting process and don't need to be added by hand. However, Creating, editing, and removing contributors, both individual people and organizations, can also be done through the Contributors section of the Meru Admin. This section covers the full lifecycle of managing contributor records: creating new contributors, editing contributor details, managing their affiliations and contributions, viewing contributor profiles on the public site, and deleting contributors when needed.*

### Access Contributor List

<Steps>

1. Log in to the Meru Admin.
2. To get to the contributor list, go to **Manage** in the main navigation and click on **Contributors**.
3. The main page will show a list of all contributors in your Meru instance. You’ll see each contributor's name, affiliation, contributions, and creation date.

</Steps>

### Create a New Contributor

<Steps>

1. Determine whether your contributor is a person or organization.
2. Click **Create person +** or **Create organization +** at the top right of the Contributors page.
3. Fill in the required fields: **First name** and **Last name**.
4. If you would like to upload an image, see the [image uploading guidelines](/reference/image-guide) for sizing recommendations.
5. Add any additional details:
- Title
- Affiliation
- Email
- ORCID Link
- Bio
- Additional links
6. Click **Save**.

</Steps>

<Badge text="Note" variant="note" /> *Here is what those details will look like on the contributer details page:*

![Screenshot of Credentials tab showing Set Password button](../../../assets/images/contributor-detail.png)

### Manage Existing Contributors

#### View Contributor Detail Page


<Steps>

1. In the contributor list, hover over the contributor you want to view.
2. Click on the button with the diagonally pointing up arrow ↗.

</Steps>

<Badge text="Note" variant="note" /> *This will navigate you out of admin and to the public contributor page on the frontend.*

#### Delete a Contributor

<Steps>

1. In the contributor list, hover over the contributor you want to view.
2. Click on the button with the trash icon.
3. Click **Delete**.

</Steps>

#### Edit Contributor Details

There are two ways to edit a contributor:
- **Quick edit drawer** — *useful for making simple updates to contributor details.*
- **Full contributor page** — *allows editing details as well as managing collection and item contributions.*

**_Quick Edit Drawer_**

<Steps>

1. In the **Contributors** list, hover over the contributor you want to edit.
2. Click on the **Edit ✏️** button that appears.
3. Make any updates to the contributor details in the drawer.
4. Click **Save**.

</Steps>

**_Full Contributor Page_**

<Steps>

1. In the **Contributors** list, click on the contributor’s name to open their full profile page.
2. Use the navigation menu on the left to access **Details**.
3. Make any updates as needed on the **Details** tab.
4. Click **Save**.

</Steps>

#### Edit Contributions

**_Create Contribution_**

<Steps>

1. In the **Contributors** list, click on the contributor’s name to open their full profile page.
2. Use the navigation menu on the left to access **Collections** or **Items**.
3. Click **Create contribution +** at the top right of the page.
4. Fill in the required field: **Collection**.
5. Add any additional details:
- Role
- Role position
- Overall position
6. Click **Save**.

</Steps>

**_Edit Contribution_**

<Steps>

1. In the **Contributors** list, click on the contributor’s name to open their full profile page.
2. Use the navigation menu on the left to access **Collections** or **Items**.
3. Hover over the contribution name that you would like to update.
4. To update the position details for the user within that contribution, click on the button with the pencil icon. Make the desired changes and click **Save**. Role cannot be updated. To change a contributors role on entity, the contribution has to be deleted and a new one created.
5. Click on the community name to navigate to that community's detail page.

</Steps>
16 changes: 16 additions & 0 deletions src/content/docs/reference/image-guide.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Image Sizing Guidelines
description: This page lists the required and recommended sizes, formats, and compression rules for images.
---

To ensure a crisp, professional appearance across all screen sizes—including retina displays—please follow the recommended image dimensions and resolutions outlined below. These guidelines help maintain visual consistency and performance across the site.

## Image Specifications

| Image Type | Recommended Size (px) | Resolution | Format | Notes |
|------------|------------------------|------------|--------|-------|
| Hero Image (One Column Layout) | 2880×980 | 72 ppi | JPG, PNG | Preferred size for all hero images. |
| Hero Image (Two Column Layout) | 1440×980 | 72 ppi | JPG, PNG | |
| Logo – Raster | 566×566 | 72 ppi | JPG, PNG | Ensures it looks crisp, especially on list pages. |
| Logo – Vector | Scalable | — | SVG | Avoid excessive white space in the margins of the logo. |
| Avatar | Minimum 100×100 | 300 ppi | JPG, PNG | Larger images are auto-resized. | |