From 99a0de875061357372b57f8b48f901e2114acb92 Mon Sep 17 00:00:00 2001 From: Ella Tanttu Date: Mon, 2 Jun 2025 16:03:13 -0700 Subject: [PATCH 01/10] [F] Add image sizing guidelines --- src/content/docs/reference/test.mdx | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 src/content/docs/reference/test.mdx diff --git a/src/content/docs/reference/test.mdx b/src/content/docs/reference/test.mdx new file mode 100644 index 0000000..0d67a5e --- /dev/null +++ b/src/content/docs/reference/test.mdx @@ -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. | | \ No newline at end of file From 285540ad377374e2701d6f0328302230c79182c3 Mon Sep 17 00:00:00 2001 From: Ella Tanttu Date: Mon, 4 Aug 2025 10:42:07 -0700 Subject: [PATCH 02/10] [C] Resolve merge conflicts --- src/content/docs/guides/users-contributers.mdx | 1 - src/content/docs/reference/test.mdx | 16 ---------------- 2 files changed, 17 deletions(-) delete mode 100644 src/content/docs/reference/test.mdx diff --git a/src/content/docs/guides/users-contributers.mdx b/src/content/docs/guides/users-contributers.mdx index f92b462..2a2ad9f 100644 --- a/src/content/docs/guides/users-contributers.mdx +++ b/src/content/docs/guides/users-contributers.mdx @@ -179,7 +179,6 @@ import { Steps, Badge } from "@astrojs/starlight/components"; #### View Contributor Detail Page - 1. In the contributor list, hover over the contributor you want to view. diff --git a/src/content/docs/reference/test.mdx b/src/content/docs/reference/test.mdx deleted file mode 100644 index 0d67a5e..0000000 --- a/src/content/docs/reference/test.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -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. | | \ No newline at end of file From 47c80278c76aa4c01ddb7975523008f47f0cb937 Mon Sep 17 00:00:00 2001 From: Ella Tanttu Date: Mon, 7 Jul 2025 15:50:23 -0700 Subject: [PATCH 03/10] [F] Add entity details page --- src/content/docs/guides/entity-details.mdx | 133 +++++++++++++++++++++ 1 file changed, 133 insertions(+) create mode 100644 src/content/docs/guides/entity-details.mdx diff --git a/src/content/docs/guides/entity-details.mdx b/src/content/docs/guides/entity-details.mdx new file mode 100644 index 0000000..a171755 --- /dev/null +++ b/src/content/docs/guides/entity-details.mdx @@ -0,0 +1,133 @@ +--- +title: Entity Details +description: Learn how to update details for entities. +sidebar: + order: 3 +--- + +import { Steps, Badge, Aside } from "@astrojs/starlight/components"; + +## Overview + +*This guide walks through how to update details for any entity, such as its hierarchical location, titles, visibility, thumbnail, summary, and publish date.* + + + +## Access Entity Details + + + +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 left menu. + + + +## Update Entity Details + +### Update Hierarchical Level of Entity + + + +1. Find the **Parent** field. +2. To change the parent of the entity, click on **Change**. +3. The modal will show a list of sibling-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 it to see its children. +4. When you've found the correct 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. + + + + _If an entity isn't able to hold child entities, it will not be selectable. You will still be able to click on the right arrow to view its child entities._ + + +### Update Titles + + + +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. + + + +### Update Visibility + + + +1. Find **Visibility** on the details page. + + + _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 **Visible Until** date selectors to define the range. + + +3. Click **Save** at the bottom of the details page. + + + +### Update DOI + + + +1. Find **DOI** on the details page. +2. _Explain DOI here._ +3. Click **Save** at the bottom of the details page. + + + +### Update Images + + + +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. + + + +### Update Summary + + + +1. Find the **Summary** field on the details page. +2. Add summary text. +3. Click **Save** at the bottom of the details page. + + + +### Update Publish Date + + + +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. + + + +### Update Schema + + _Schema should be set when the entity is harvested._ + + + +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. + + From 976f6d2156806c7254ee998415ff0793c2213b27 Mon Sep 17 00:00:00 2001 From: Ella Tanttu Date: Sun, 3 Aug 2025 14:54:49 -0700 Subject: [PATCH 04/10] [F] Add glossary reference page --- src/content/docs/guides/entity-details.mdx | 10 +++------- src/content/docs/guides/harvesting.mdx | 18 +++--------------- src/content/docs/reference/glossary.mdx | 21 +++++++++++++++++++++ 3 files changed, 27 insertions(+), 22 deletions(-) create mode 100644 src/content/docs/reference/glossary.mdx diff --git a/src/content/docs/guides/entity-details.mdx b/src/content/docs/guides/entity-details.mdx index a171755..3bf2e4c 100644 --- a/src/content/docs/guides/entity-details.mdx +++ b/src/content/docs/guides/entity-details.mdx @@ -5,18 +5,14 @@ sidebar: order: 3 --- -import { Steps, Badge, Aside } from "@astrojs/starlight/components"; +import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; + + ## Overview *This guide walks through how to update details for any entity, such as its hierarchical location, titles, visibility, thumbnail, summary, and publish date.* - - ## Access Entity Details diff --git a/src/content/docs/guides/harvesting.mdx b/src/content/docs/guides/harvesting.mdx index 7b07577..34ed9b1 100644 --- a/src/content/docs/guides/harvesting.mdx +++ b/src/content/docs/guides/harvesting.mdx @@ -2,24 +2,12 @@ title: Harvesting description: Learn how to configure sources, mappings, and attempts to harvest external content into Meru. sidebar: - order: 5 + order: 6 --- -import { Aside, Steps, Badge, Card } from "@astrojs/starlight/components"; +import { Aside, Steps, Badge, Card, LinkCard } from "@astrojs/starlight/components"; - + ## Access Harvesting Dashboard diff --git a/src/content/docs/reference/glossary.mdx b/src/content/docs/reference/glossary.mdx new file mode 100644 index 0000000..8af75b7 --- /dev/null +++ b/src/content/docs/reference/glossary.mdx @@ -0,0 +1,21 @@ +--- +title: Glossary +description: This page lists glossary terms for commonly used vocabulary throughout this documentation. +--- + +## General Terms + +| Term | Definition| +|------------|------------------------| +|**Entity** | A generalized term used to refer to collections and items. The structure of these content types may vary depending on the context, and using a single term allows for consistent instructions across different levels of hierarchy. | + + +## Harvesting + +| Term | Definition| +|------------|------------------------| +|**Harvesting Sources** | External systems that Meru is harvesting content from. For example, the URL of an OAIPMH feed. The harvesting source record would contain any protocol details or authentication. | +| **Harvesting Sets** | Collections of content within a harvest source. In OAIPMH that would be a set that was exposed by the feed. They could represent a journal, departments, or grouped content in general. +| **Harvest Mappings** | Define the relationship between the content and the external sources and locations in Meru. They have templating logic that explains how we transform a piece of content or data in the harvested data to what we store in Meru. +| **Harvesting Attempts** | An individual event where Meru tries to retrieve and process content from a configured harvest source, based on the mappings and settings you've provided. +| **Harvest Records** | Singular flat collection of metadata that could be transformed into one or more entities in Meru. An OAIPMH feed typically doesn’t expose the full hierarchical structure of journal content. It doesn’t tell us the Journal → the volume → the issue → and the article. We just get the article and have to infer the hierarchy. A single harvest record can lead to multiple entities getting created in Meru. \ No newline at end of file From 73e983f82a958740a896e6b0ac953d411db1823b Mon Sep 17 00:00:00 2001 From: Ella Tanttu Date: Sun, 3 Aug 2025 15:00:15 -0700 Subject: [PATCH 05/10] [F] Update get started page --- src/content/docs/guides/1-get-started.mdx | 62 ++++++++ .../guides/{keycloak.mdx => 2-keycloak.mdx} | 0 ...ntity-details.mdx => 3-entity-details.mdx} | 0 .../docs/guides/4-entity-orderings.mdx | 133 ++++++++++++++++++ ...tributers.mdx => 7-users-contributers.mdx} | 2 +- .../{harvesting.mdx => 8-harvesting.mdx} | 2 +- ...bal-settings.mdx => 9-global-settings.mdx} | 2 +- src/content/docs/guides/get-started.mdx | 25 ---- src/content/docs/reference/glossary.mdx | 2 +- 9 files changed, 199 insertions(+), 29 deletions(-) create mode 100644 src/content/docs/guides/1-get-started.mdx rename src/content/docs/guides/{keycloak.mdx => 2-keycloak.mdx} (100%) rename src/content/docs/guides/{entity-details.mdx => 3-entity-details.mdx} (100%) create mode 100644 src/content/docs/guides/4-entity-orderings.mdx rename src/content/docs/guides/{users-contributers.mdx => 7-users-contributers.mdx} (99%) rename src/content/docs/guides/{harvesting.mdx => 8-harvesting.mdx} (99%) rename src/content/docs/guides/{global-settings.mdx => 9-global-settings.mdx} (99%) delete mode 100644 src/content/docs/guides/get-started.mdx diff --git a/src/content/docs/guides/1-get-started.mdx b/src/content/docs/guides/1-get-started.mdx new file mode 100644 index 0000000..8c56314 --- /dev/null +++ b/src/content/docs/guides/1-get-started.mdx @@ -0,0 +1,62 @@ +--- +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) */} + + + + + + + + + + +## Reference + + + + + diff --git a/src/content/docs/guides/keycloak.mdx b/src/content/docs/guides/2-keycloak.mdx similarity index 100% rename from src/content/docs/guides/keycloak.mdx rename to src/content/docs/guides/2-keycloak.mdx diff --git a/src/content/docs/guides/entity-details.mdx b/src/content/docs/guides/3-entity-details.mdx similarity index 100% rename from src/content/docs/guides/entity-details.mdx rename to src/content/docs/guides/3-entity-details.mdx diff --git a/src/content/docs/guides/4-entity-orderings.mdx b/src/content/docs/guides/4-entity-orderings.mdx new file mode 100644 index 0000000..97eaf37 --- /dev/null +++ b/src/content/docs/guides/4-entity-orderings.mdx @@ -0,0 +1,133 @@ +--- +title: Entity Orderings +description: Get started with using Meru. +sidebar: + order: 4 +--- + +import { Steps, Badge, Aside } from "@astrojs/starlight/components"; + +## Overview + +*This guide walks through how to update details for any entity, such as its hierarchical location, titles, visibility, thumbnail, summary, and publish date.* + + + +## Access Entity Details + + + +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 left menu. + + + +## Update Entity Details + +### Update Hierarchical Level of Entity + + + +1. Find the **Parent** field. +2. To change the parent of the entity, click on **Change**. +3. The modal will show a list of sibling-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 it to see its children. +4. When you've found the correct 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. + + + + _If an entity isn't able to hold child entities, it will not be selectable. You will still be able to click on the right arrow to view its child entities._ + + +### Update Titles + + + +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. + + + +### Update Visibility + + + +1. Find **Visibility** on the details page. + + + _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 **Visible Until** date selectors to define the range. + + +3. Click **Save** at the bottom of the details page. + + + +### Update DOI + + + +1. Find **DOI** on the details page. +2. _Explain DOI here._ +3. Click **Save** at the bottom of the details page. + + + +### Update Images + + + +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. + + + +### Update Summary + + + +1. Find the **Summary** field on the details page. +2. Add summary text. +3. Click **Save** at the bottom of the details page. + + + +### Update Publish Date + + + +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. + + + +### Update Schema + + _Schema should be set when the entity is harvested._ + + + +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. + + diff --git a/src/content/docs/guides/users-contributers.mdx b/src/content/docs/guides/7-users-contributers.mdx similarity index 99% rename from src/content/docs/guides/users-contributers.mdx rename to src/content/docs/guides/7-users-contributers.mdx index 2a2ad9f..09a96e8 100644 --- a/src/content/docs/guides/users-contributers.mdx +++ b/src/content/docs/guides/7-users-contributers.mdx @@ -2,7 +2,7 @@ title: Users & Contributors description: Learn how to manage users and contributors. sidebar: - order: 4 + order: 7 --- import { Steps, Badge } from "@astrojs/starlight/components"; diff --git a/src/content/docs/guides/harvesting.mdx b/src/content/docs/guides/8-harvesting.mdx similarity index 99% rename from src/content/docs/guides/harvesting.mdx rename to src/content/docs/guides/8-harvesting.mdx index 34ed9b1..60d6494 100644 --- a/src/content/docs/guides/harvesting.mdx +++ b/src/content/docs/guides/8-harvesting.mdx @@ -2,7 +2,7 @@ title: Harvesting description: Learn how to configure sources, mappings, and attempts to harvest external content into Meru. sidebar: - order: 6 + order: 8 --- import { Aside, Steps, Badge, Card, LinkCard } from "@astrojs/starlight/components"; diff --git a/src/content/docs/guides/global-settings.mdx b/src/content/docs/guides/9-global-settings.mdx similarity index 99% rename from src/content/docs/guides/global-settings.mdx rename to src/content/docs/guides/9-global-settings.mdx index 9f96572..be74d0f 100644 --- a/src/content/docs/guides/global-settings.mdx +++ b/src/content/docs/guides/9-global-settings.mdx @@ -2,7 +2,7 @@ title: Global Settings description: Learn how to edit global settings. sidebar: - order: 6 + order: 9 --- import { Steps, Badge } from "@astrojs/starlight/components"; diff --git a/src/content/docs/guides/get-started.mdx b/src/content/docs/guides/get-started.mdx deleted file mode 100644 index 9b6746e..0000000 --- a/src/content/docs/guides/get-started.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -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 - - - - - diff --git a/src/content/docs/reference/glossary.mdx b/src/content/docs/reference/glossary.mdx index 8af75b7..82cc630 100644 --- a/src/content/docs/reference/glossary.mdx +++ b/src/content/docs/reference/glossary.mdx @@ -1,6 +1,6 @@ --- title: Glossary -description: This page lists glossary terms for commonly used vocabulary throughout this documentation. +description: A list of glossary terms commonly used throughout this documentation. --- ## General Terms From e64c77f48132ce123a837b3946cd827fdd035b52 Mon Sep 17 00:00:00 2001 From: Ella Tanttu Date: Sun, 3 Aug 2025 15:52:14 -0700 Subject: [PATCH 06/10] [F] Add entity orderings page --- src/content/docs/guides/3-entity-details.mdx | 2 +- .../docs/guides/4-entity-orderings.mdx | 129 ++++-------------- src/content/docs/index.mdx | 2 +- 3 files changed, 27 insertions(+), 106 deletions(-) diff --git a/src/content/docs/guides/3-entity-details.mdx b/src/content/docs/guides/3-entity-details.mdx index 3bf2e4c..97cc340 100644 --- a/src/content/docs/guides/3-entity-details.mdx +++ b/src/content/docs/guides/3-entity-details.mdx @@ -19,7 +19,7 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; 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 left menu. +3. Once you have the entity open, click on the **Manage** tab under the entity title. Click **Details** in the menu. diff --git a/src/content/docs/guides/4-entity-orderings.mdx b/src/content/docs/guides/4-entity-orderings.mdx index 97eaf37..45aa9a9 100644 --- a/src/content/docs/guides/4-entity-orderings.mdx +++ b/src/content/docs/guides/4-entity-orderings.mdx @@ -1,133 +1,54 @@ --- title: Entity Orderings -description: Get started with using Meru. +description: Learn how to update orderings for entities. sidebar: order: 4 --- -import { Steps, Badge, Aside } from "@astrojs/starlight/components"; +import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; ## Overview -*This guide walks through how to update details for any entity, such as its hierarchical location, titles, visibility, thumbnail, summary, and publish date.* +*This guide walks through how to create and update orderings of descendents or links within an entity.* - - -## Access Entity Details +## Access Entity Orderings 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 left menu. - - - -## Update Entity Details - -### Update Hierarchical Level of Entity - - - -1. Find the **Parent** field. -2. To change the parent of the entity, click on **Change**. -3. The modal will show a list of sibling-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 it to see its children. -4. When you've found the correct 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. - - - - _If an entity isn't able to hold child entities, it will not be selectable. You will still be able to click on the right arrow to view its child entities._ - - -### Update Titles - - - -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. - - - -### Update Visibility - - - -1. Find **Visibility** on the details page. - - - _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 **Visible Until** date selectors to define the range. - - -3. Click **Save** at the bottom of the details page. - - - -### Update DOI - - - -1. Find **DOI** on the details page. -2. _Explain DOI here._ -3. Click **Save** at the bottom of the details page. - - - -### Update Images - - - -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. +3. Once you have the entity open, click on the **Manage** tab under the entity title. Click **Orderings** in the menu. -### Update Summary +## Add a New Entity Ordering -1. Find the **Summary** field on the details page. -2. Add summary text. -3. Click **Save** at the bottom of the details page. - +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**. -### Update Publish Date +## Update an Existing Entity Ordering -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. - +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** +7. Click **Save**. -### Update Schema - - _Schema should be set when the entity is harvested._ - - - -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. - - + \ No newline at end of file diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index c1e8203..0f98e4a 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -6,6 +6,6 @@ hero: tagline: 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. actions: - text: Get Started - link: /guides/get-started + link: /guides/1-get-started icon: right-arrow --- From 1bde8702416a8f781aaa9d791950b4592950bd61 Mon Sep 17 00:00:00 2001 From: Ella Tanttu Date: Sun, 3 Aug 2025 16:17:26 -0700 Subject: [PATCH 07/10] [F] Add entity links page --- src/content/docs/guides/1-get-started.mdx | 5 +++ src/content/docs/guides/5-entity-links.mdx | 46 ++++++++++++++++++++++ 2 files changed, 51 insertions(+) create mode 100644 src/content/docs/guides/5-entity-links.mdx diff --git a/src/content/docs/guides/1-get-started.mdx b/src/content/docs/guides/1-get-started.mdx index 8c56314..9836cd6 100644 --- a/src/content/docs/guides/1-get-started.mdx +++ b/src/content/docs/guides/1-get-started.mdx @@ -29,6 +29,11 @@ These docs are still a work in progress! We're actively building out the documen href="/guides/4-entity-orderings" description="Learn how to update orderings for entities." /> + + +## Access Entity Links + + + +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. + + + +## Add a New Entity Link + + + +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** and if it is a non descended entity, select **reference**. +5. Click **save**. + + + +## Remove an Entity Link + + + +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**. + + \ No newline at end of file From 1967b8e3d43ee5ea5943fc6c482fea653961638e Mon Sep 17 00:00:00 2001 From: Ella Tanttu Date: Sun, 3 Aug 2025 16:21:48 -0700 Subject: [PATCH 08/10] [F] Edit entity orderings page --- .../docs/guides/4-entity-orderings.mdx | 22 ++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/src/content/docs/guides/4-entity-orderings.mdx b/src/content/docs/guides/4-entity-orderings.mdx index 45aa9a9..1821de5 100644 --- a/src/content/docs/guides/4-entity-orderings.mdx +++ b/src/content/docs/guides/4-entity-orderings.mdx @@ -40,7 +40,6 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; - 1. Hover over the desired ordering. 2. Click on the button with the pencil icon. 3. Make desired changes to the following fields: @@ -51,4 +50,25 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; - **Display As** 7. Click **Save**. + + +## View an Existing Entity Ordering on the Frontend + + + +1. Hover over the desired ordering. +2. Click on the button with the diagonal arrow. + + + +## Disable/Enable an Existing Entity Ordering + + + +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**. + \ No newline at end of file From a262c4d171bcf4496c63c13e59b53d936a28b964 Mon Sep 17 00:00:00 2001 From: Ella Tanttu Date: Sun, 3 Aug 2025 17:07:06 -0700 Subject: [PATCH 09/10] [F] Add entity access page --- astro.config.ts | 2 +- src/content/docs/guides/1-get-started.mdx | 5 +++ src/content/docs/guides/3-entity-details.mdx | 24 ++++------- .../docs/guides/4-entity-orderings.mdx | 4 -- src/content/docs/guides/5-entity-links.mdx | 8 +--- src/content/docs/guides/6-entity-access.mdx | 41 +++++++++++++++++++ .../docs/guides/7-users-contributers.mdx | 2 +- src/content/docs/reference/glossary.mdx | 3 ++ 8 files changed, 61 insertions(+), 28 deletions(-) create mode 100644 src/content/docs/guides/6-entity-access.mdx diff --git a/astro.config.ts b/astro.config.ts index 11c631b..20b81b6 100644 --- a/astro.config.ts +++ b/astro.config.ts @@ -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" }, diff --git a/src/content/docs/guides/1-get-started.mdx b/src/content/docs/guides/1-get-started.mdx index 9836cd6..0537b5a 100644 --- a/src/content/docs/guides/1-get-started.mdx +++ b/src/content/docs/guides/1-get-started.mdx @@ -34,6 +34,11 @@ These docs are still a work in progress! We're actively building out the documen href="/guides/5-entity-links" description="Learn how to update links for entities." /> + -## Overview - -*This guide walks through how to update details for any entity, such as its hierarchical location, titles, visibility, thumbnail, summary, and publish date.* ## Access Entity Details @@ -31,13 +28,13 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; 1. Find the **Parent** field. 2. To change the parent of the entity, click on **Change**. -3. The modal will show a list of sibling-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 it to see its children. -4. When you've found the correct entity, click on it so that it is highlighted with a blue background and click **Save** at the bottom of the modal. +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. - _If an entity isn't able to hold child entities, it will not be selectable. You will still be able to click on the right arrow to view its child entities._ + _Some entities will not be selectable. You will still be able to click on the right arrow to view their child entities._ ### Update Titles @@ -55,20 +52,15 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; 1. Find **Visibility** on the details page. - - - _This is a required field. The default value is **Visible**._ - + _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 **Visible Until** date selectors to define the range. + - **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. @@ -78,7 +70,7 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; 1. Find **DOI** on the details page. -2. _Explain DOI here._ +2. _Explain DOI here._ 3. Click **Save** at the bottom of the details page. @@ -110,13 +102,13 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; 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. +4. Click **Save** at the bottom of the details page. ### Update Schema - _Schema should be set when the entity is harvested._ + _Schema is defined when the entity is harvested. See the [Harvesting page](/guides/8-harvesting) for a detailed explanation._ diff --git a/src/content/docs/guides/4-entity-orderings.mdx b/src/content/docs/guides/4-entity-orderings.mdx index 1821de5..a04bcb6 100644 --- a/src/content/docs/guides/4-entity-orderings.mdx +++ b/src/content/docs/guides/4-entity-orderings.mdx @@ -7,10 +7,6 @@ sidebar: import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; -## Overview - -*This guide walks through how to create and update orderings of descendents or links within an entity.* - ## Access Entity Orderings diff --git a/src/content/docs/guides/5-entity-links.mdx b/src/content/docs/guides/5-entity-links.mdx index 1aeaedc..443fefa 100644 --- a/src/content/docs/guides/5-entity-links.mdx +++ b/src/content/docs/guides/5-entity-links.mdx @@ -7,10 +7,6 @@ sidebar: import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; -## Overview - -*This guide walks through how to create and update links for entities.* - ## Access Entity Links @@ -30,7 +26,7 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; 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** and if it is a non descended entity, select **reference**. +4. If the linked entity is a descendent, select **Contains**. If it is a non-descended entity, select **reference**. 5. Click **save**. @@ -41,6 +37,6 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; 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**. +3. You will be prompted to confirm your choice. Click **Delete**, **Cancel**, or **Close**. \ No newline at end of file diff --git a/src/content/docs/guides/6-entity-access.mdx b/src/content/docs/guides/6-entity-access.mdx new file mode 100644 index 0000000..02bbd21 --- /dev/null +++ b/src/content/docs/guides/6-entity-access.mdx @@ -0,0 +1,41 @@ +--- +title: Entity Access +description: Learn how to update access to entities. +sidebar: + order: 6 +--- + +import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; + + + +## Navigate to Entity Access + + + +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. + + + +## Add Access to an Entity + + + +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. + + _Explain Role permissions here._ + - **Manager**: + - **Editor**: + - **Reader**: +5. Click **save**. + + + +## 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**._ \ No newline at end of file diff --git a/src/content/docs/guides/7-users-contributers.mdx b/src/content/docs/guides/7-users-contributers.mdx index 09a96e8..f5c58f7 100644 --- a/src/content/docs/guides/7-users-contributers.mdx +++ b/src/content/docs/guides/7-users-contributers.mdx @@ -9,7 +9,7 @@ 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.* +*Creating and removing users, as well as assigning administation privileges, is handled through the [Keycloak user dashboard](/guides/2-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 diff --git a/src/content/docs/reference/glossary.mdx b/src/content/docs/reference/glossary.mdx index 82cc630..73a97fd 100644 --- a/src/content/docs/reference/glossary.mdx +++ b/src/content/docs/reference/glossary.mdx @@ -3,11 +3,14 @@ title: Glossary description: A list of glossary terms commonly used throughout this documentation. --- +import { Badge } from "@astrojs/starlight/components"; + ## General Terms | Term | Definition| |------------|------------------------| |**Entity** | A generalized term used to refer to collections and items. The structure of these content types may vary depending on the context, and using a single term allows for consistent instructions across different levels of hierarchy. | +| **Entity Link** | _Add entity link definition here._ | ## Harvesting From 13fc946a878f3f396d1a7e159b240056d17374d2 Mon Sep 17 00:00:00 2001 From: Ella Tanttu Date: Mon, 4 Aug 2025 10:44:34 -0700 Subject: [PATCH 10/10] [C] Lint --- src/content/docs/guides/1-get-started.mdx | 2 +- src/content/docs/guides/3-entity-details.mdx | 22 ++++++----- .../docs/guides/4-entity-orderings.mdx | 15 +++---- src/content/docs/guides/5-entity-links.mdx | 2 +- src/content/docs/guides/6-entity-access.mdx | 9 ++--- .../docs/guides/7-users-contributers.mdx | 39 ++++++++++--------- src/content/docs/guides/8-harvesting.mdx | 8 +++- src/content/docs/guides/9-global-settings.mdx | 8 ++-- src/content/docs/reference/glossary.mdx | 23 ++++++----- src/content/docs/reference/image-guide.mdx | 14 +++---- 10 files changed, 76 insertions(+), 66 deletions(-) diff --git a/src/content/docs/guides/1-get-started.mdx b/src/content/docs/guides/1-get-started.mdx index 0537b5a..da400a2 100644 --- a/src/content/docs/guides/1-get-started.mdx +++ b/src/content/docs/guides/1-get-started.mdx @@ -53,7 +53,7 @@ These docs are still a work in progress! We're actively building out the documen title="Global Settings" href="/guides/9-global-settings" description="Learn how to edit global settings." - /> + /> ## Reference diff --git a/src/content/docs/guides/3-entity-details.mdx b/src/content/docs/guides/3-entity-details.mdx index 1dc9d61..5d08193 100644 --- a/src/content/docs/guides/3-entity-details.mdx +++ b/src/content/docs/guides/3-entity-details.mdx @@ -9,7 +9,6 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; - ## Access Entity Details @@ -34,8 +33,8 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; - _Some entities will not be selectable. You will still be able to click on the right arrow to view their child entities._ - + _Some entities will not be selectable. You +will still be able to click on the right arrow to view their child entities._ ### Update Titles @@ -53,17 +52,18 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; 1. Find **Visibility** on the details page. - _This is a required field. The default value is **Visible**._ -2. Select the desired visibility level. + _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. + - **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. - + ### Update DOI @@ -108,7 +108,9 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; ### Update Schema - _Schema is defined when the entity is harvested. See the [Harvesting page](/guides/8-harvesting) for a detailed explanation._ + _Schema is defined when the entity is +harvested. See the [Harvesting page](/guides/8-harvesting) for a detailed +explanation._ diff --git a/src/content/docs/guides/4-entity-orderings.mdx b/src/content/docs/guides/4-entity-orderings.mdx index a04bcb6..b4499e1 100644 --- a/src/content/docs/guides/4-entity-orderings.mdx +++ b/src/content/docs/guides/4-entity-orderings.mdx @@ -30,6 +30,7 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; 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**. + ## Update an Existing Entity Ordering @@ -39,12 +40,12 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; 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** -7. Click **Save**. + - **Name** + - **Relationships** + - **Schemas** + - **Order By** + - **Display As** +4. Click **Save**. @@ -67,4 +68,4 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; 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**. - \ No newline at end of file + diff --git a/src/content/docs/guides/5-entity-links.mdx b/src/content/docs/guides/5-entity-links.mdx index 443fefa..80014b0 100644 --- a/src/content/docs/guides/5-entity-links.mdx +++ b/src/content/docs/guides/5-entity-links.mdx @@ -39,4 +39,4 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; 2. Click on the **Trash** icon. 3. You will be prompted to confirm your choice. Click **Delete**, **Cancel**, or **Close**. - \ No newline at end of file + diff --git a/src/content/docs/guides/6-entity-access.mdx b/src/content/docs/guides/6-entity-access.mdx index 02bbd21..8101a43 100644 --- a/src/content/docs/guides/6-entity-access.mdx +++ b/src/content/docs/guides/6-entity-access.mdx @@ -28,14 +28,13 @@ import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components"; 3. Click on the desired name. 4. Select the **role** of the user. - _Explain Role permissions here._ - - **Manager**: - - **Editor**: - - **Reader**: + _Explain Role permissions + here._ - **Manager**: - **Editor**: - **Reader**: + 5. Click **save**. ## 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**._ \ No newline at end of file +_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**._ diff --git a/src/content/docs/guides/7-users-contributers.mdx b/src/content/docs/guides/7-users-contributers.mdx index f5c58f7..b145bcb 100644 --- a/src/content/docs/guides/7-users-contributers.mdx +++ b/src/content/docs/guides/7-users-contributers.mdx @@ -9,7 +9,7 @@ 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/2-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.* +_Creating and removing users, as well as assigning administation privileges, is handled through the [Keycloak user dashboard](/guides/2-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 @@ -18,8 +18,8 @@ import { Steps, Badge } from "@astrojs/starlight/components"; 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**. - _Only those with `global_admin` privileges can edit user accounts._ - + _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. @@ -140,7 +140,7 @@ import { Steps, Badge } from "@astrojs/starlight/components"; ## 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.* +_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 @@ -161,17 +161,18 @@ import { Steps, Badge } from "@astrojs/starlight/components"; 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 + - Title + - Affiliation + - Email + - ORCID Link + - Bio + - Additional links 6. Click **Save**. - *Here is what those details will look like on the contributer details page:* + *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) @@ -186,7 +187,8 @@ import { Steps, Badge } from "@astrojs/starlight/components"; - *This will navigate you out of admin and to the public contributor page on the frontend.* + *This will navigate you out of admin and to +the public contributor page on the frontend.* #### Delete a Contributor @@ -201,8 +203,9 @@ import { Steps, Badge } from "@astrojs/starlight/components"; #### 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** — _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_** @@ -237,9 +240,9 @@ There are two ways to edit a contributor: 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 + - Role + - Role position + - Overall position 6. Click **Save**. @@ -254,4 +257,4 @@ There are two ways to edit a contributor: 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. - \ No newline at end of file + diff --git a/src/content/docs/guides/8-harvesting.mdx b/src/content/docs/guides/8-harvesting.mdx index 60d6494..e009429 100644 --- a/src/content/docs/guides/8-harvesting.mdx +++ b/src/content/docs/guides/8-harvesting.mdx @@ -5,7 +5,13 @@ sidebar: order: 8 --- -import { Aside, Steps, Badge, Card, LinkCard } from "@astrojs/starlight/components"; +import { + Aside, + Steps, + Badge, + Card, + LinkCard, +} from "@astrojs/starlight/components"; diff --git a/src/content/docs/guides/9-global-settings.mdx b/src/content/docs/guides/9-global-settings.mdx index be74d0f..0087ebd 100644 --- a/src/content/docs/guides/9-global-settings.mdx +++ b/src/content/docs/guides/9-global-settings.mdx @@ -9,7 +9,7 @@ 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.* +_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 @@ -18,8 +18,8 @@ import { Steps, Badge } from "@astrojs/starlight/components"; 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**. - _The global settings are only visible to users with `global_admin` privileges._ - + _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. @@ -55,4 +55,4 @@ import { Steps, Badge } from "@astrojs/starlight/components"; - **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**. \ No newline at end of file + **Copyright 2025 Meru**. diff --git a/src/content/docs/reference/glossary.mdx b/src/content/docs/reference/glossary.mdx index 73a97fd..ba297cb 100644 --- a/src/content/docs/reference/glossary.mdx +++ b/src/content/docs/reference/glossary.mdx @@ -7,18 +7,17 @@ import { Badge } from "@astrojs/starlight/components"; ## General Terms -| Term | Definition| -|------------|------------------------| -|**Entity** | A generalized term used to refer to collections and items. The structure of these content types may vary depending on the context, and using a single term allows for consistent instructions across different levels of hierarchy. | -| **Entity Link** | _Add entity link definition here._ | - +| Term | Definition | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Entity** | A generalized term used to refer to collections and items. The structure of these content types may vary depending on the context, and using a single term allows for consistent instructions across different levels of hierarchy. | +| **Entity Link** | _Add entity link definition here._ | ## Harvesting -| Term | Definition| -|------------|------------------------| -|**Harvesting Sources** | External systems that Meru is harvesting content from. For example, the URL of an OAIPMH feed. The harvesting source record would contain any protocol details or authentication. | -| **Harvesting Sets** | Collections of content within a harvest source. In OAIPMH that would be a set that was exposed by the feed. They could represent a journal, departments, or grouped content in general. -| **Harvest Mappings** | Define the relationship between the content and the external sources and locations in Meru. They have templating logic that explains how we transform a piece of content or data in the harvested data to what we store in Meru. -| **Harvesting Attempts** | An individual event where Meru tries to retrieve and process content from a configured harvest source, based on the mappings and settings you've provided. -| **Harvest Records** | Singular flat collection of metadata that could be transformed into one or more entities in Meru. An OAIPMH feed typically doesn’t expose the full hierarchical structure of journal content. It doesn’t tell us the Journal → the volume → the issue → and the article. We just get the article and have to infer the hierarchy. A single harvest record can lead to multiple entities getting created in Meru. \ No newline at end of file +| Term | Definition | +| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Harvesting Sources** | External systems that Meru is harvesting content from. For example, the URL of an OAIPMH feed. The harvesting source record would contain any protocol details or authentication. | +| **Harvesting Sets** | Collections of content within a harvest source. In OAIPMH that would be a set that was exposed by the feed. They could represent a journal, departments, or grouped content in general. | +| **Harvest Mappings** | Define the relationship between the content and the external sources and locations in Meru. They have templating logic that explains how we transform a piece of content or data in the harvested data to what we store in Meru. | +| **Harvesting Attempts** | An individual event where Meru tries to retrieve and process content from a configured harvest source, based on the mappings and settings you've provided. | +| **Harvest Records** | Singular flat collection of metadata that could be transformed into one or more entities in Meru. An OAIPMH feed typically doesn’t expose the full hierarchical structure of journal content. It doesn’t tell us the Journal → the volume → the issue → and the article. We just get the article and have to infer the hierarchy. A single harvest record can lead to multiple entities getting created in Meru. | diff --git a/src/content/docs/reference/image-guide.mdx b/src/content/docs/reference/image-guide.mdx index 0d67a5e..aa4b395 100644 --- a/src/content/docs/reference/image-guide.mdx +++ b/src/content/docs/reference/image-guide.mdx @@ -7,10 +7,10 @@ To ensure a crisp, professional appearance across all screen sizes—including r ## 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. | | \ No newline at end of file +| 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. | |