Skip to content

Commit

Permalink
more updates
Browse files Browse the repository at this point in the history
  • Loading branch information
marcolarosa committed Oct 26, 2024
1 parent 8dd2644 commit 4e099ed
Show file tree
Hide file tree
Showing 30 changed files with 78 additions and 19 deletions.
4 changes: 4 additions & 0 deletions sidebar-menu.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ export const sidebar = [
text: "Working with your data",
link: "/docs/guide/working-with-a-crate",
},
{
text: "Creating a knowledge base",
link: "/docs/guide/creating-a-knowledgebase",
},
{
text: "Browsing your data",
link: "/docs/guide/browse",
Expand Down
52 changes: 52 additions & 0 deletions src/docs/guide/creating-a-knowledgebase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: Creating a knowledge base
aside: true
---

# Creating a knowledge base

## Saving entities for re-use

Often times, you will carefully craft an entity definition that will be useful elsewhere. An obvious
example is when you define yourself as an author. In that case, your entity definition will have
your name and a URL as your unique identifier (e.g. an ORCID) and you can save that definition as a
template for re-use in other work.

In the following image we can see what will be saved as a template. By setting depth to 1 linked
entities will be resolved and included. Note that in both cases (depth 0 or 1) only properties will
be included. Dangling references to other entities in this metadata will not be included.

<ImageComponent src="/images/guide-knowledgebase/template1.webp" />

Then, when describing content, you will be presented with matching templates. Note the middle entry
under the section title "Associate an entity from saved templates".

<ImageComponent src="/images/guide-knowledgebase/template2.webp" />

## Loading an RO-Crate

You can also load entities from an RO-Crate into your personal knowledge base. Perhaps you've
created a dataset as described in the [TKLabels article](/docs/articles/creating-a-dataset.html).

Notice the highlighted section in the following screenshot? That's where we manage our saved
templates. In the screenshot you can see that there are two templates: one describing the Describo
organisation and one describing me as a Person.

<ImageComponent src="/images/guide-knowledgebase/dataset18.webp"></ImageComponent>

<div class="my-6">
Press the button <Button>Load templates from another dataset</Button>. A sidebar will open where you
can select a folder containing an RO-Crate. Select the folder where you created the RO-Crate dataset
you want to load data from. Describo will load the RO-Crate metadata and show you the entity types it contains. In this
case we are ingesting all of the TKLabel entities (20 of them).
</div>

<ImageComponent src="/images/guide-knowledgebase/dataset19.webp"></ImageComponent>

When it's done, those entities will now be loaded into your personal datastore. In the following
screenshot we can see the TKlabel entities are now also available.

<ImageComponent src="/images/guide-knowledgebase/dataset20.webp"></ImageComponent>

When you create a [Vocabulary](/docs/guide/vocabulary.html) that specifies that a property with a
`TKLabel` entity as its value, Describo will offer you these entities as selections to choose from.
39 changes: 21 additions & 18 deletions src/docs/guide/working-with-a-crate.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,30 +46,33 @@ The main editor window has a controls bar along the top. On it there are:

<ImageComponent src="/images/guide-working-with-a-crate/controls.webp" />

## Verifying the data
## Verifying your work

A crucial aspect is verifying your work against the RO Crate specification to ensure that it's
compliant. If you've registered and bought credits to use the assistant, you can use the AI
Assistant to check your work against the spec.
::: tip info

<ImageComponent src="/images/guide-working-with-a-crate/desktop6.webp" />
- You will need to [register](/docs/guide/register.html) and
[purchase credits to use the Assistant.](/docs/guide/purchase-credits.html)

## Saving entities for re-use
:::

Often times, you will carefully craft an entity definition that will be useful elsewhere. An obvious
example is when you define yourself as an author. In that case, your entity definition will have
your name and a URL as your unique identifier (e.g. an ORCID) and you can save that definition as a
template for re-use in other work.
<div class="my-6">
An important part of any project is verifying your work. On the Describe tab, in the left panel
where the file browser is, there is another tab Verify. Select it and press the button
<Button>Start the assistant</Button>. When you do, the assistant will read the RO-Crate spec and
your metadata. When it's ready, you can query your data for correctness against the spec.
</div>

In the following image we can see what will be saved as a template. By setting depth to 1 linked
entities will be resolved and included. Note that in both cases (depth 0 or 1) only properties will
be included. Dangling references to other entities in this metadata will not be included.
<div class="flex flex-col space-y-1 md:flex-row md:space-x-1 md:space-y-0 my-6">
<ImageComponent src="/images/guide-working-with-a-crate/dataset15.webp"></ImageComponent>
<ImageComponent src="/images/guide-working-with-a-crate/dataset16.webp"></ImageComponent>
</div>

<ImageComponent src="/images/guide-working-with-a-crate/template1.webp" />
<div class="my-6">
In the following image we pressed the button <Button>Check root dataset</Button> and then in the
message view we see the question (in the blue box) and the assistant's response (in green). In this
way, you can direct the assistant to check your work.
</div>

Then, when describing content, you will be presented with matching templates. Note the middle entry
under the section title "Associate an entity from saved templates".

<ImageComponent src="/images/guide-working-with-a-crate/template2.webp" />
<ImageComponent src="/images/guide-working-with-a-crate/dataset17.webp"></ImageComponent>

<Disqus />
2 changes: 1 addition & 1 deletion src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ layout: home
</InfoPanelComponent>

<InfoPanelComponent>
<template #title>Linked data to tables</template>
<template #title>Linked data - as a table</template>
<template #text>
<p>
Describo lets you view your data in a clean, organized table format that's as straightforward as a spreadsheet. You can easily search through your information and choose exactly which details you want to display on screen.
Expand Down
Binary file modified src/public/images/guide-browse/browse1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/guide-browse/browse1.webp
Binary file not shown.
Binary file modified src/public/images/guide-browse/browse2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/guide-browse/browse2.webp
Binary file not shown.
Binary file modified src/public/images/guide-browse/browse3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/guide-browse/browse3.webp
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified src/public/images/tour/desktop8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/tour/desktop8.webp
Binary file not shown.

0 comments on commit 4e099ed

Please sign in to comment.