Skip to content

Commit f808c8f

Browse files
committed
Update the links on the content
1 parent f9be305 commit f808c8f

7 files changed

Lines changed: 11 additions & 11 deletions

File tree

docs/building-a-component.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ _description: |
4040
4141
### Bootstrap.yml
4242
43-
[This file](glossary#bootstrap-file) describes the data that all new instances of your component will start with when created using Clay's REST API. It's essential because each time Amphora starts up it will read from this file and [write this starter data](glossary#bootstrap-action) into the database.
43+
[This file](glossary.md#bootstrap-file) describes the data that all new instances of your component will start with when created using Clay's REST API. It's essential because each time Amphora starts up it will read from this file and [write this starter data](glossary.md#bootstrap-action) into the database.
4444
4545
Ensure your component has a `bootstrap.yml`, here's an example:
4646

@@ -65,7 +65,7 @@ Both of these functions receive the following data:
6565

6666
- `uri` (String): the uri of the component
6767
- `data` (Object): the component instance's data
68-
- `locals` (Object): an object [containing information about the request](glossary#locals)
68+
- `locals` (Object): an object [containing information about the request](glossary.md#locals)
6969

7070
Both of these functions must return _either an Object or a Promise which resolves an Object_ whose value is the data for the component. On a `save` the Object will be written to the database and on a `render` the Object will be passed to the data composer. Both the save() and render() methods are optional.
7171

@@ -129,4 +129,4 @@ While this introduction covered the most common files in a component directory w
129129

130130
Assuming you're using the [Clay starter](https://github.com/clay/clay-starter) and that your component name is `my-component`, you should be able to navigate to [`localhost/_components/my-component`](localhost/_components/my-component) and see the default data for your component.
131131

132-
In the following pages we'll look at iterating on a component, compiling your component's assets/styles and adding your component to [component lists](https://docs.clayplatform.com/clay-kiln/docs/manipulating_components#component-lists) in other components.
132+
In the following pages we'll look at iterating on a component, compiling your component's assets/styles and adding your component to [component lists](https://docs.clayplatform.com/clay-kiln/docs/manipulating-components.md#component-lists) in other components.

docs/glossary.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Amphora is the data composer and REST API of Clay. Its core responsibilities inc
1919
- Discovering each plugin available in an instance of Clay
2020
- Migrating component data as components iterate over time
2121

22-
You can get more details on our [Amphora documentation](https://docs.clayplatform.com/amphora/docs/intro)
22+
You can get more details on our [Amphora documentation](https://docs.clayplatform.com/amphora/docs/introduction)
2323

2424
---
2525

@@ -84,7 +84,7 @@ A user can enter edit mode in two ways:
8484

8585
Kiln is actually just a component itself and abides by the same API's as any other component.
8686

87-
You can get more details on our [Kiln documentation](https://docs.clayplatform.com/clay-kiln/docs/intro)
87+
You can get more details on our [Kiln documentation](https://docs.clayplatform.com/clay-kiln/docs/introduction)
8888

8989
---
9090

docs/layouts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Layouts have all the same affordances as components, but there are a few importa
1616
* Layouts have their own metadata
1717

1818
## Page Areas
19-
Layouts are unique because they can contain placeholders for properties on a page that are filled during composition. The areas where a page's data can be merged into the layout's data are called **page areas**. The reference to a page area is simply a string that references a [component-list on a page](pages#page-specific-data).
19+
Layouts are unique because they can contain placeholders for properties on a page that are filled during composition. The areas where a page's data can be merged into the layout's data are called **page areas**. The reference to a page area is simply a string that references a [component-list on a page](pages.md#page-specific-data).
2020

2121
For example:
2222

@@ -63,7 +63,7 @@ During composition of the page for rendering the data from the page will be merg
6363
---
6464

6565
## Defining Page Areas For Editing
66-
While referencing data from a page works by setting a property in the layout to the same value as a component-list in the page data, there's a little more that has to be done so that Kiln knows how to edit page areas properly. For more detailed information, [see the Kiln docs](https://docs.clayplatform.com/clay-kiln/docs/intro), but below is a brief excerpt from a Layout schema that is defining a Page Area called "main".
66+
While referencing data from a page works by setting a property in the layout to the same value as a component-list in the page data, there's a little more that has to be done so that Kiln knows how to edit page areas properly. For more detailed information, [see the Kiln docs](https://docs.clayplatform.com/clay-kiln/docs/introduction), but below is a brief excerpt from a Layout schema that is defining a Page Area called "main".
6767
```js
6868
main:
6969
_componentList:

docs/lists.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ Once you know the id of a list you would like to see the contents of, simply req
5656
... // Truncated for brevity
5757
]
5858
```
59-
The important thing to realize is that the data in this list is arbitrary and is not something dictated by the Clay platform. The data is kept up-to-date by components as they are edited and published. This list can then turn around and be used by any component (such as a [data source for autocomplete](https://docs.clayplatform.com/clay-kiln/docs/input#simple-list)) or any external service. The content of lists are completely dictated by the implementation.
59+
The important thing to realize is that the data in this list is arbitrary and is not something dictated by the Clay platform. The data is kept up-to-date by components as they are edited and published. This list can then turn around and be used by any component (such as a [data source for autocomplete](https://docs.clayplatform.com/clay-kiln/docs/inputs#simple-list)) or any external service. The content of lists are completely dictated by the implementation.

docs/pages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ For more details on interacting with the pages API, see the Amphora documentatio
1313
---
1414

1515
## Page Specific Data
16-
All data specific to a page should be an Array of component instances. These component instances will be rendered on the page in a [component-list](https://docs.clayplatform.com/clay-kiln/docs/manipulating_components#component-lists) inside of the layout's template, which is discussed more in the Layouts documentation.
16+
All data specific to a page should be an Array of component instances. These component instances will be rendered on the page in a [component-list](https://docs.clayplatform.com/clay-kiln/docs/manipulating-components#component-lists) inside of the layout's template, which is discussed more in the Layouts documentation.
1717

1818
It should be noted that the order of the component instances inside the Array will determine the order in which the component data is rendered in each component-list, but the order of the properties in the page data does not matter at all. The DOM flow (when talking about HTML pages) is determined by the layout's template, not the page data.
1919

docs/uris.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar_label: Uris
99

1010
A uri is binding between a publicly accessible url and a specific [page](pages.md) in your Clay instance. When browsing the web you're generally navigating between human-readable URLs like www.vulture.com/movies/ or www.thecut.com/2018/08/baby-squirrel-attack-germany.html. But when you're creating and editing pages in Clay you're normally dealing with page instances with random ids, like www.thecut.com/_pages/cjko0bdjj008qi5ye57e00qyk.html. This is where uris come in.
1111

12-
_Uris are a bridge between a public facing url and a specific page instance_. When a page is published a public url for the page is determined ([see "Publishing" in Amphora docs](https://docs.clayplatform.com/amphora/docs/publish)), and when that happens a uri is created.
12+
_Uris are a bridge between a public facing url and a specific page instance_. When a page is published a public url for the page is determined ([see "Publishing" in Amphora docs](https://docs.clayplatform.com/amphora/docs/publishing)), and when that happens a uri is created.
1313

1414
---
1515

docs/users.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ Found at: /_users/dXNlckBnb29nbGUuY29tQGdvb2dsZQ==
4040
}
4141
```
4242

43-
The user's id is a Base64 encoded string of the `<username>@<provider` and the authentication level is used to define permissions when editing content via [Kiln](https://docs.clayplatform.com/clay-kiln/docs/intro).
43+
The user's id is a Base64 encoded string of the `<username>@<provider` and the authentication level is used to define permissions when editing content via [Kiln](https://docs.clayplatform.com/clay-kiln/docs/introduction).

0 commit comments

Comments
 (0)