From 62f3b6e7bce97ec4084bcb3b8e9b5d7c71a32a54 Mon Sep 17 00:00:00 2001 From: Oscar Polanco Date: Mon, 15 Jul 2019 15:05:42 -0400 Subject: [PATCH] Update the links on the content --- docs/building-a-component.md | 6 +++--- docs/glossary.md | 4 ++-- docs/layouts.md | 4 ++-- docs/lists.md | 2 +- docs/pages.md | 2 +- docs/uris.md | 2 +- docs/users.md | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/building-a-component.md b/docs/building-a-component.md index dd8ec85..72780ac 100644 --- a/docs/building-a-component.md +++ b/docs/building-a-component.md @@ -40,7 +40,7 @@ _description: | ### Bootstrap.yml -[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. +[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. Ensure your component has a `bootstrap.yml`, here's an example: @@ -65,7 +65,7 @@ Both of these functions receive the following data: - `uri` (String): the uri of the component - `data` (Object): the component instance's data -- `locals` (Object): an object [containing information about the request](glossary#locals) +- `locals` (Object): an object [containing information about the request](glossary.md#locals) 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. @@ -129,4 +129,4 @@ While this introduction covered the most common files in a component directory w 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. -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. +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. diff --git a/docs/glossary.md b/docs/glossary.md index 0ce8abe..6dea5a9 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -19,7 +19,7 @@ Amphora is the data composer and REST API of Clay. Its core responsibilities inc - Discovering each plugin available in an instance of Clay - Migrating component data as components iterate over time -You can get more details on our [Amphora documentation](https://docs.clayplatform.com/amphora/docs/intro) +You can get more details on our [Amphora documentation](https://docs.clayplatform.com/amphora/docs/introduction) --- @@ -84,7 +84,7 @@ A user can enter edit mode in two ways: Kiln is actually just a component itself and abides by the same API's as any other component. -You can get more details on our [Kiln documentation](https://docs.clayplatform.com/clay-kiln/docs/intro) +You can get more details on our [Kiln documentation](https://docs.clayplatform.com/clay-kiln/docs/introduction) --- diff --git a/docs/layouts.md b/docs/layouts.md index b58da7b..48e6550 100644 --- a/docs/layouts.md +++ b/docs/layouts.md @@ -16,7 +16,7 @@ Layouts have all the same affordances as components, but there are a few importa * Layouts have their own metadata ## Page Areas -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). +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). For example: @@ -63,7 +63,7 @@ During composition of the page for rendering the data from the page will be merg --- ## Defining Page Areas For Editing -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". +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". ```js main: _componentList: diff --git a/docs/lists.md b/docs/lists.md index c29ca3a..525ff6d 100644 --- a/docs/lists.md +++ b/docs/lists.md @@ -56,4 +56,4 @@ Once you know the id of a list you would like to see the contents of, simply req ... // Truncated for brevity ] ``` -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. +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. diff --git a/docs/pages.md b/docs/pages.md index 5eeaa0a..fb79e2f 100644 --- a/docs/pages.md +++ b/docs/pages.md @@ -13,7 +13,7 @@ For more details on interacting with the pages API, see the Amphora documentatio --- ## Page Specific Data -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. +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. 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. diff --git a/docs/uris.md b/docs/uris.md index 4ebace7..a736603 100644 --- a/docs/uris.md +++ b/docs/uris.md @@ -9,7 +9,7 @@ sidebar_label: Uris 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. -_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. +_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. --- diff --git a/docs/users.md b/docs/users.md index c102b67..dc7e1ba 100644 --- a/docs/users.md +++ b/docs/users.md @@ -40,4 +40,4 @@ Found at: /_users/dXNlckBnb29nbGUuY29tQGdvb2dsZQ== } ``` -The user's id is a Base64 encoded string of the `@@