Skip to content
Open
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
2 changes: 1 addition & 1 deletion astro.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export default defineConfig({
label: "Guides",
// items: [
// // Each item here is one entry in the navigation menu.
// { label: "Get Started", slug: "guides/get-started" },
// { label: "Get Started", slug: "guides/1-get-started" },
// { label: "Example Guide", slug: "guides/example" },
// ],
autogenerate: { directory: "guides" },
Expand Down
72 changes: 72 additions & 0 deletions src/content/docs/guides/1-get-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: Get Started
description: Get started with using Meru.
sidebar:
order: 1
---

import { CardGrid, LinkCard } from "@astrojs/starlight/components";

These docs are still a work in progress! We're actively building out the documentation alongside the project, so some sections may be incomplete or subject to change as we refine both the application and our documentation.

## Guides

{/* I plan to remove the numbers from the file names once I'm finished writing these docs. (ET) */}

<CardGrid>
<LinkCard
title="Keycloak"
href="/guides/2-keycloak"
description="Learn how to manage Meru users in Keycloak."
/>
<LinkCard
title="Entity Details"
href="/guides/3-entity-details"
description="Learn how to update details for entities."
/>
<LinkCard
title="Entity Orderings"
href="/guides/4-entity-orderings"
description="Learn how to update orderings for entities."
/>
<LinkCard
title="Entity Links"
href="/guides/5-entity-links"
description="Learn how to update links for entities."
/>
<LinkCard
title="Entity Access"
href="/guides/6-entity-access"
description="Learn how to update access to entities."
/>
<LinkCard
title="Users & Contributors"
href="/guides/7-users-contributers"
description="Learn how to manage users and contributors."
/>
<LinkCard
title="Harvesting"
href="/guides/8-harvesting"
description="An overview of Meru's harvesting interfaces."
/>
<LinkCard
title="Global Settings"
href="/guides/9-global-settings"
description="Learn how to edit global settings."
/>
</CardGrid>

## Reference

<CardGrid>
<LinkCard
title="Glossary"
href="/reference/glossary"
description="A list of glossary terms commonly used throughout this documentation."
/>
<LinkCard
title="Image Guide"
href="/reference/glossary"
description="Required and recommended sizes, formats, and compression rules for images."
/>
</CardGrid>
123 changes: 123 additions & 0 deletions src/content/docs/guides/3-entity-details.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
---
title: Entity Details
description: Learn how to update details for entities.
sidebar:
order: 3
---

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

<LinkCard title="Glossary" href="/reference/glossary" />

## Access Entity Details

<Steps>

1. Log in to the Meru Admin.
2. Using Collections, Items, or search in the main navigation, navigate to the entity that you would like to update.
3. Once you have the entity open, click on the **Manage** tab under the entity title. Click **Details** in the menu.

</Steps>

## Update Entity Details

### Update Hierarchical Level of Entity

<Steps>

1. Find the **Parent** field.
2. To change the parent of the entity, click on **Change**.
3. The modal will show a list of child-level entities to the current parent. You can either navigate to a higher level using the back arrow **←**, or click on the forward arrow **→** next to an item to see its children.
4. When you've found the new parent entity, click on it so that it is highlighted with a blue background and click **Save** at the bottom of the modal.
5. Click **Save** at the bottom of the details page.

</Steps>

<Badge text="Note" variant="note" /> _Some entities will not be selectable. You
will still be able to click on the right arrow to view their child entities._

### Update Titles

<Steps>

1. Find the **Title** and **Subtitle** fields.
2. Enter or change the titles to your desired values.
3. Click **Save** at the bottom of the details page.

</Steps>

### Update Visibility

<Steps>

1. Find **Visibility** on the details page.

<Badge text="Note" variant="note" /> _This is a required field. The default
value is **Visible**._

2. Select the desired visibility level.

- **Visible** will make the entity and its children visible to users.
- **Hidden** will make the entity and its children invisible to users.
- **Limited** will make the entity and its children visible to users during a specified date range. Use the **Visible After** and/or **Visible Until** date selectors to define the range.

3. Click **Save** at the bottom of the details page.

</Steps>

### Update DOI

<Steps>

1. Find **DOI** on the details page.
2. <Badge text="Content WIP" variant="caution" /> _Explain DOI here._
3. Click **Save** at the bottom of the details page.

</Steps>

### Update Images

<Steps>

1. Find the **Thumbnail** / **Hero Image** fields on the details page.
2. Upload or drag and drop your desired images to the fields. See the [image uploading guidelines](/reference/image-guide) for sizing recommendations.
3. Click **Save** at the bottom of the details page.

</Steps>

### Update Summary

<Steps>

1. Find the **Summary** field on the details page.
2. Add summary text.
3. Click **Save** at the bottom of the details page.

</Steps>

### Update Publish Date

<Steps>

1. Find the **Published** field on the details page.
2. Add a year to the **Year** field.
3. If desired, add **Month** and **Day**.
4. Click **Save** at the bottom of the details page.

</Steps>

### Update Schema

<Badge text="Note" variant="note" /> _Schema is defined when the entity is
harvested. See the [Harvesting page](/guides/8-harvesting) for a detailed
explanation._

<Steps>

1. Find the **Schema** section on the details page.
2. Click on **Change**.
3. Select the correct schema.
4. Add any details about the entity's schema to the **About** field.
5. Click **Save** at the bottom of the details page.

</Steps>
71 changes: 71 additions & 0 deletions src/content/docs/guides/4-entity-orderings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: Entity Orderings
description: Learn how to update orderings for entities.
sidebar:
order: 4
---

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

<LinkCard title="Glossary" href="/reference/glossary" />

## Access Entity Orderings

<Steps>

1. Log in to the Meru Admin.
2. Using Collections, Items, or search in the main navigation, navigate to the entity that you would like to update.
3. Once you have the entity open, click on the **Manage** tab under the entity title. Click **Orderings** in the menu.

</Steps>

## Add a New Entity Ordering

<Steps>

1. Click on **Add Ordering +**.
2. Add a **Name**. Common names include "Theses & Dissertations", "Papers", "Series", and "Books."
3. Select the relationship of the entities to be included in the ordering.
4. Select the schemas to be included in the ordering. If none are selected, all schemas will be permitted.
5. Select the **Order By** criteria. Multiple options are permitted and can be reordered by dragging and dropping. At least one selection is required.
6. Select whether to display the ordering as a **List** or **Tree**.
7. Click **Save**.

</Steps>

## Update an Existing Entity Ordering

<Steps>

1. Hover over the desired ordering.
2. Click on the button with the pencil icon.
3. Make desired changes to the following fields:
- **Name**
- **Relationships**
- **Schemas**
- **Order By**
- **Display As**
4. Click **Save**.

</Steps>

## View an Existing Entity Ordering on the Frontend

<Steps>

1. Hover over the desired ordering.
2. Click on the button with the diagonal arrow.

</Steps>

## Disable/Enable an Existing Entity Ordering

<Steps>

1. Hover over the desired ordering.
2. Click on the **Disable** button.
3. You will be prompted to confirm your choice, click **Disable**, **Cancel**, or **Close**.
4. If an entity ordering is Disabled and you would like to enable it again, click on **Enable**.
5. You will be prompted to confirm your choice, click **Enable**, **Cancel**, or **Close**.

</Steps>
42 changes: 42 additions & 0 deletions src/content/docs/guides/5-entity-links.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: Entity Links
description: Learn how to update links for entities.
sidebar:
order: 5
---

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

<LinkCard title="Glossary" href="/reference/glossary" />

## Access Entity Links

<Steps>

1. Log in to the Meru Admin.
2. Using Collections, Items, or search in the main navigation, navigate to the entity that you would like to update.
3. Once you have the entity open, click on the **Manage** tab under the entity title. Click **Links** in the menu.

</Steps>

## Add a New Entity Link

<Steps>

1. Click on **Add Link +**.
2. In the **Collection or Item** field, begin typing your entity link title. Matching entities will appear to choose from. _This may take a few seconds._
3. Click on the desired entity title.
4. If the linked entity is a descendent, select **Contains**. If it is a non-descended entity, select **reference**.
5. Click **save**.

</Steps>

## Remove an Entity Link

<Steps>

1. Hover over the desired link.
2. Click on the **Trash** icon.
3. You will be prompted to confirm your choice. Click **Delete**, **Cancel**, or **Close**.

</Steps>
40 changes: 40 additions & 0 deletions src/content/docs/guides/6-entity-access.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Entity Access
description: Learn how to update access to entities.
sidebar:
order: 6
---

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

<LinkCard title="Glossary" href="/reference/glossary" />

## Navigate to Entity Access

<Steps>

1. Log in to the Meru Admin.
2. Using Collections, Items, or search in the main navigation, navigate to the entity that you would like to update.
3. Once you have the entity open, click on the **Manage** tab under the entity title. Click **Access** in the menu.

</Steps>

## Add Access to an Entity

<Steps>

1. Click on **Add Access +**.
2. In the **User** field, begin typing the user's name. Matching names will appear to choose from.
3. Click on the desired name.
4. Select the **role** of the user.

<Badge text="Content WIP" variant="caution" /> _Explain Role permissions
here._ - **Manager**: - **Editor**: - **Reader**:

5. Click **save**.

</Steps>

## Inherited Roles

_Global Admins will have inherited roles for all entities. To view a list of non-inherited users who have access, click on **Hide Inherited Roles**._
Loading