Skip to content

Commit

Permalink
updating content
Browse files Browse the repository at this point in the history
  • Loading branch information
marcolarosa committed Aug 29, 2024
1 parent 8a1d6a2 commit 82b5b59
Show file tree
Hide file tree
Showing 20 changed files with 73 additions and 80 deletions.
4 changes: 2 additions & 2 deletions src/docs/articles/how-your-data-is-handled.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ Any metadata that you create with Describo remains in the source folder inside a
If you choose to register with the Describo cloud and purchase credits to use the text extraction,
entity recognition or assistant capabilities, the data that you select for processing will be
uploaded to the Describo cloud. Detailed information about the Describo Cloud is at
[Cloud Services and Data Processing](/docs/guide/data-processing) but following is a plain english
explanation of that content.
[Cloud Services and Data Processing](/docs/guide/data-processing.html) but following is a plain
english explanation of that content.

- Describo does not assert any right or title to any of the outputs of the cloud service. The
Describo Cloud empowers you to create, while you retain complete ownership of your outputs.
Expand Down
10 changes: 5 additions & 5 deletions src/docs/articles/taytay-sings-the-budget-blues.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,14 +145,14 @@ Following is a fun, albeit frivolous, example that demonstrates what you can do.
If you want to try this with your own data, it's easy and you can be up and running in about 5
minutes!

- [Download the application - FREE](/desktop)
- [Register - FREE](/docs/guide/register)
- [Purchase Assistant Credits - $5 ](/docs/guide/purchase-credits)
- [Download the application - FREE](/desktop.html)
- [Register - FREE](/docs/guide/register.html)
- [Purchase Assistant Credits - $5 ](/docs/guide/purchase-credits.html)

And if you have questions about how your data is used and where it's processed:

- [Terms and conditions](/terms-and-conditions#describo-cloud)
- [Where your data is processed](/docs/guide/data-processing)
- [Terms and conditions](/terms-and-conditions.html#describo-cloud)
- [Where your data is processed](/docs/guide/data-processing.html)

<Disqus />

Expand Down
38 changes: 23 additions & 15 deletions src/docs/articles/why-use-it.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,9 @@ online workspace. Issues that Describo mitigates.
### Describo lives here

Describo is for people working with text based content in various formats. It provides tools for
them [to manipulate their data and transform it](/docs/guide/transforming-content);
[mine it for information using AI tools and cloud services](/docs/guide/assistant-supported-discovery);
[describe what they're finding as linked data entity relationships](/docs/guide/working-with-a-crate);
them [to manipulate their data and transform it](/docs/guide/transforming-content.html);
[mine it for information using AI tools and cloud services](/docs/guide/assistant-supported-discovery.html);
[describe what they're finding as linked data entity relationships](/docs/guide/working-with-a-crate.html);
and ultimately, publish their work.

Describo produces data objects in a standardised format: the
Expand Down Expand Up @@ -162,31 +162,39 @@ it.
<template #text>
<p><strong>The problem statement:</strong></p>
<p>
You could be a librarian, an archivist or a historian. When confronted with a literal
box full of files, the next 3 - 6 months of your life will look something like this.
You are an archivist or historian. When confronted with a literal
box full of files, you might identify with the following:
</p>
<p>
Let's start by digitising the content. The format is probably going
to be TIFF as it's a recognised preservation format. But it's not a great format
for dissemination so let's convert the images to web accessible formats in case we
end up putting this content online. Step 1 complete - content digitised.
As an archivist you will likely digitise each individual file using a compressionless
format like TIFF. But, as it's not a great format
for dissemination you will then produce web accessible formats as well.
</p>
<p>
Discovery. Now that we have the content in digitised form, let's find out what
it contains. Who does it talk about? What are they discussing? Why are they discussing it?
As a historian you will probably sift through the contents looking for information
that is useful in your area of research. You may digitise those documents of interest
to take away and perform further analysis on.
</p>
<p>
In both cases, the next step involves understanding the content.
Who does it talk about? What are they discussing? Why are they discussing it?
What relationships can we uncover from the documents? You will meticulously read,
consider and annotate each and every document in the set, carefully creating
the data structures you need to answer the questions you have.
</p>
<p>
When you're done, you will likely write some metadata capturing your scholarship and
As an archivist you will likely produce a finding aid to support discovery of the
content whist as a historian you may use the descriptions you created to link
the content into your field of work.
</p>
<p>
When you're done, you may write some metadata capturing your scholarship and
publish it alongside your work. Then, you'll deposit your research into a repository
of some kind.
</p>
<p>
And of course, maybe you weren't 'gifted' the box of materials. Maybe you just emerged from the archives
with 2000 images on your phone and your eyes squinting from exposure to sunlight! Either way,
the work ahead of you will largely look the same.
with 2000 images on your phone and your eyes squinting from exposure to sunlight!
</p>
<p><strong>How Describo can help:</strong></p>
<p>
Expand Down Expand Up @@ -227,7 +235,7 @@ it.
describe a manuscript, page by page, without the content ever leaving their computer. However,
subject to appropriate permissions being sought, they could also use the cloud services to accelerate that process
as they have been specifically designed and architected with data privacy in mind. To read more
about that see: <a href="/docs/articles/how-your-data-is-handled">How is data handled inside Describo?</a>
about that see: <a href="/docs/articles/how-your-data-is-handled.html">How is data handled inside Describo?</a>
</p>
</template>
</SectionComponent>
Expand Down
2 changes: 1 addition & 1 deletion src/docs/component/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ module.exports = {
content: [
"./src/**/*.html",
"./src/**/*.{js,jsx,ts,tsx,vue}",
"./node_modules/@describo/**/*.vue",
"./node_modules/@describo/crate-builder-component/src/**/*.vue",
],
theme: {
extend: {},
Expand Down
6 changes: 3 additions & 3 deletions src/docs/component/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ aside: false
back to your app for saving or handling as you wish.
</div>
<div>
<LinkComponent link="/docs/component/get-started" target="">Read on to get started.</LinkComponent>
<LinkComponent link="/docs/component/get-started.html" target="">Read on to get started.</LinkComponent>
</div>
</div>
</template>
Expand Down Expand Up @@ -60,7 +60,7 @@ aside: false
<template #title>Themable</template>
<template #text>
Control all aspects of the styling of the component to suit your application. See
<LinkComponent link="/docs/component/themes" target="">the themes documentation for
<LinkComponent link="/docs/component/themes.html" target="">the themes documentation for
more information.</LinkComponent>
</template>
<template #content>
Expand All @@ -71,7 +71,7 @@ aside: false
<template #title>Configurable</template>
<template #text>
Control all aspects of the behaviour like rendering crates in read only mode.
<LinkComponent link="/docs/component/usage-and-configuration" target="">the configuration documentation for
<LinkComponent link="/docs/component/usage-and-configuration.html" target="">the configuration documentation for
more information.</LinkComponent>
</template>
<template #content>
Expand Down
2 changes: 1 addition & 1 deletion src/docs/component/usage-and-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ aside: false

::: tip

Be sure to also read the [next page about Data Validation](./validation).
Be sure to also read the [next page about Data Validation](./validation.html).

:::

Expand Down
2 changes: 1 addition & 1 deletion src/docs/component/validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ensure that you data won't be rejected by the component. Or worse, cause unexpec

## Validate entity @id

This is so important that it has its [own page explaining it](/docs/component/identifiers).
This is so important that it has its [own page explaining it](/docs/component/identifiers.html).

```JS
import { validateId } from "@describo/crate-builder-component/src/crate-builder/CrateManager/validate-identifier.js"
Expand Down
5 changes: 0 additions & 5 deletions src/docs/guide/configuration/data-processing.md

This file was deleted.

6 changes: 0 additions & 6 deletions src/docs/guide/configuration/general-settings.md

This file was deleted.

5 changes: 0 additions & 5 deletions src/docs/guide/configuration/purchase-credits.md

This file was deleted.

5 changes: 0 additions & 5 deletions src/docs/guide/configuration/subscribe.md

This file was deleted.

4 changes: 2 additions & 2 deletions src/docs/guide/data-processing.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ aside: false

::: tip INFO

Ensure you also read the page [Terms and Conditions](/terms-and-conditions#describo-cloud) to find
out how your data is handled by the Describo Cloud.
Ensure you also read the page [Terms and Conditions](/terms-and-conditions.html#describo-cloud) to
find out how your data is handled by the Describo Cloud.

:::

Expand Down
5 changes: 4 additions & 1 deletion src/docs/guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ aside: false

[[toc]]

Describo can be downloaded from <LinkComponent link="/desktop" target="_blank">here.</LinkComponent>
<div>
Describo can be downloaded from
<LinkComponent link="/desktop.html" target="_blank">here.</LinkComponent>
</div>

## MacOS

Expand Down
4 changes: 2 additions & 2 deletions src/docs/guide/register.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ the services.

Ensure you have reviewed:

- [Cloud Services and Data Processing](/docs/guide/data-processing) to learn about the services
used and where your data is processed;
- [Cloud Services and Data Processing](/docs/guide/data-processing.html) to learn about the
services used and where your data is processed;
- [Pricing](/pricing.html);
- [Terms and Conditions of use](/terms-and-conditions.html);
- [Privacy Policy](/privacy-policy.html).
Expand Down
2 changes: 1 addition & 1 deletion src/docs/guide/transcribing-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ aside: false
::: tip Info

To use the text extraction and entity recognition capabilities you need to first
[register with describo.cloud.](/docs/guide/register)
[register with describo.cloud.](/docs/guide/register.html)

:::

Expand Down
4 changes: 2 additions & 2 deletions src/docs/guide/transforming-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ aside: false

::: tip Info

The tools in this section require a [registration with describo.cloud](/docs/guide/register) and
credits for the assistant, text extraction and named entity recognition capabilities.
The tools in this section require a [registration with describo.cloud](/docs/guide/register.html)
and credits for the assistant, text extraction and named entity recognition capabilities.

:::

Expand Down
11 changes: 6 additions & 5 deletions src/docs/guide/visualising-the-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ aside: false
::: tip Info

This section of Describo is not just for producing nice visualisations of the network structure. It
goes hand in hand with the [Discover](/docs/guide/assistant-supported-discovery) section in your
digital discovery process. That is, you can use Discover to deep dive into the data for specific
information that you are interested in and / or know exists. Or, you can use these tools to get an
overview of what you actually have as the first part of the process of understanding your data.
goes hand in hand with the [Discover](/docs/guide/assistant-supported-discovery.html) section in
your digital discovery process. That is, you can use Discover to deep dive into the data for
specific information that you are interested in and / or know exists. Or, you can use these tools to
get an overview of what you actually have as the first part of the process of understanding your
data.

:::

Expand Down Expand Up @@ -62,7 +63,7 @@ button at the top of the controls.

When you do, the network structure in the metadata will be displayed. Following is a visualisation
of the entities, topics, themes and subjects in the
[Taylor Swift Song Dataset](/docs/articles/taytay-sings-the-budget-blues).
[Taylor Swift Song Dataset](/docs/articles/taytay-sings-the-budget-blues.html).

<ImageComponent src="/images/guide-visualise/visualise3.webp"></ImageComponent>

Expand Down
12 changes: 6 additions & 6 deletions src/docs/profiles/classes-and-inputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ In this example the profile tells the UI that the value of the author property c
type Person or Organization. The UI will then guide the user in the creation of those entities or
linking an entity either existing in the crate or looked up from a datasource elsewhere.

Please see the [detailed documentation on types](./types.md)
Please see the [detailed documentation on types](./types.html)

### name property

Expand All @@ -119,14 +119,14 @@ inputs of the relevant type.
## ANY Class

When defining what a property can link to, you can select from a given set of types like Text or
Number (see the [types](/docs/profiles/types) documentation). Anything else will be treated as an
entity. For example, specifying `type: ['Text', 'Person', 'Organisation']` allows the user to attach
some textual content or link an entity of type Person or Organisation. However, what if the user
should be able to attach an entity of any type?
Number (see the [types](/docs/profiles/types.html) documentation). Anything else will be treated as
an entity. For example, specifying `type: ['Text', 'Person', 'Organisation']` allows the user to
attach some textual content or link an entity of type Person or Organisation. However, what if the
user should be able to attach an entity of any type?

The `ANY` class is a special indicator to Describo to give the user the ability to attach an entity
of any type at that point. This is required for things like actions and relationships (see
[the documentation for resolve](./resolve.md)) where you are trying to describe structures between
[the documentation for resolve](./resolve.html)) where you are trying to describe structures between
groups of entities.

Example:
Expand Down
12 changes: 7 additions & 5 deletions src/docs/profiles/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,16 @@ allowed to describe.

Features of a profile:

- [Primitives](/docs/profiles/types) to specify the type of data required: Text, TextArea,
- [Primitives](/docs/profiles/types.html) to specify the type of data required: Text, TextArea,
Boolean, Date, DateTime, Time, Number, Geo, URL, Select, SelectURL, SelectObject
- Constraints to further limit the data input. Available on Text, TextArea and Number types
- [Layouts](/docs/profiles/layouts) to specify property grouping and which properties to display.
- [Associations](/docs/profiles/associations) to specify inverse property associations
- [Resolve](/docs/profiles/resolve) to specify how complex relational entities like Actions should
- [Layouts](/docs/profiles/layouts.html) to specify property grouping and which properties to
display.
- [Localisation](/docs/profiles/localisation) to translate entity classes in the User Interface.
- [Associations](/docs/profiles/associations.html) to specify inverse property associations
- [Resolve](/docs/profiles/resolve.html) to specify how complex relational entities like Actions
should display.
- [Localisation](/docs/profiles/localisation.html) to translate entity classes in the User
Interface.

## Sharing your profile

Expand Down
14 changes: 7 additions & 7 deletions src/docs/profiles/profile-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,40 +52,40 @@ The context section allows you to provide a context for this profile. Although o
highly recommended that you provide a context that suits the profile you have created. Describo will
then disable the context editor and emit crates with this context in it.

See [All about contexts](./contexts.md) for more information.
See [All about contexts](./contexts.html) for more information.

## Layouts

This section defines how to group properties and display them in tabs.

See [Layouts for how to define them and why you would want to.](./layouts.md)
See [Layouts for how to define them and why you would want to.](./layouts.html)

## Property Associations

This sections defines inverse property relationships so that describo can automatically create them
on data input.

See [Property Associations for a detailed account of these sections.](./associations.md)
See [Property Associations for a detailed account of these sections.](./associations.html)

## Localisation

The localisation sections allows you to translate classes (e.g. Author) and primitives (e.g. Text,
Date etc) into your own language.

See [All about localisation](./localisation.md) for more information.
See [All about localisation](./localisation.html) for more information.

## Resolve

The resolve section allows you to specify that entities linked from linking type entities (e.g.
Relationships and Actions - Create, Move, Update etc.) are to be displayed as well.

See [All about resolve](./resolve.md) for more information.
See [All about resolve](./resolve.html) for more information.

## Classes

This section contains class definitions users can use in their descriptions.

See [Classes and Inputs for a detailed account of this section.](./classes-and-inputs.md)
See [Classes and Inputs for a detailed account of this section.](./classes-and-inputs.html)

## Lookup

Expand All @@ -94,4 +94,4 @@ country definition. Rather than asking a user to create an entity of type Countr
relevant properties to adequately describe it, you could just provide a lookup to a pre defined
Country definition that they can inject into the crate.

See [Lookups for a detailed account of this section.](./lookups.md)
See [Lookups for a detailed account of this section.](./lookups.html)

0 comments on commit 82b5b59

Please sign in to comment.