Skip to content

Commit

Permalink
Fix doc links (#2160)
Browse files Browse the repository at this point in the history
  • Loading branch information
@emmatown @timleslie
emmatown authored and timleslie committed Jan 6, 2020
1 parent 933b311 commit 0a510ec
Show file tree
Hide file tree
Showing 41 changed files with 523 additions and 251 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ If you develop custom fields, adapters, apps or any other Keystone feature, (or

## Code of Conduct

KeystoneJS adheres to the [Contributor Covenant Code of Conduct](code-of-conduct.md).
KeystoneJS adheres to the [Contributor Covenant Code of Conduct](/code-of-conduct.md).

## Repository Setup

Expand Down
10 changes: 5 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ This project follows the [all-contributors](https://github.com/all-contributors/

**Contributions of any kind are welcome!**

You will find the set-up steps in this readme and full release processes and project guidelines in [`CONTRIBUTING.md`](./CONTRIBUTING.md).
You will find the set-up steps in this readme and full release processes and project guidelines in [`CONTRIBUTING.md`](/CONTRIBUTING.md).

### Contributors

Expand Down Expand Up @@ -135,7 +135,7 @@ We'd like to start by thanking all our wonderful contributors:
These projects are designed to show off different aspects of KeystoneJS features
at a range of complexities (from a simple Todo App to a complex Meetup Site).

See the [`demo-projects/README.md`](./demo-projects/README.md) docs to get
See the [`demo-projects/README.md`](/demo-projects/README.md) docs to get
started.

### Development Practices
Expand Down Expand Up @@ -166,15 +166,15 @@ yarn
yarn dev
```

See [`demo-projects/README.md`](./demo-projects/README.md) for more details on
See [`demo-projects/README.md`](/demo-projects/README.md) for more details on
the available demo projects.

#### Note For Windows Users

While running `yarn` on Windows, the process may fail with an error such as this:

```sh
error { [Error: EPERM: operation not permitted, symlink 'C:\Users\user\Documents\keystone-5\packages\arch\packages\alert\src\index.js' -> 'C:\Users\user\Documents\keystone-5\packages\arch\packages\alert\dist\alert.cjs.js.flow']
Error: EPERM: operation not permitted, symlink 'C:\Users\user\Documents\keystone-5\packages\arch\packages\alert\src\index.js' -> 'C:\Users\user\Documents\keystone-5\packages\arch\packages\alert\dist\alert.cjs.js.flow'
```

This is due to permission restrictions regarding the creation of [symbolic links](https://blogs.windows.com/windowsdeveloper/2016/12/02/symlinks-windows-10/). To solve this, you should enable Windows' [Developer Mode](https://docs.microsoft.com/en-us/windows/uwp/get-started/enable-your-device-for-development?redirectedfrom=MSDN) and run `yarn` again.
Expand Down Expand Up @@ -274,7 +274,7 @@ Where `simple_tests` can be replaced with any job listed in

## Code of Conduct

KeystoneJS adheres to the [Contributor Covenant Code of Conduct](code-of-conduct.md).
KeystoneJS adheres to the [Contributor Covenant Code of Conduct](/code-of-conduct.md).

## License

Expand Down
4 changes: 2 additions & 2 deletions docs/api/access-control.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ order: 5
Control who can do what with your GraphQL API.

_Note_: This is the API documentation for Access Control. For getting started,
see the [Access Control Guide](/guides/access-control) or the
[Authentication Guide](/guides/authentication).
see the [Access Control Guide](/docs/guides/access-control.md) or the
[Authentication Guide](/docs/guides/authentication.md).

## Table of Contents

Expand Down
7 changes: 4 additions & 3 deletions docs/api/authentication.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ order: 4

# Authentication

Authentication strategies allow users to identify themselves to KeystoneJS. This can be used to restrict access to the AdminUI, and to configure [access controls](/guides/access-control/).
Authentication strategies allow users to identify themselves to KeystoneJS.
This can be used to restrict access to the AdminUI, and to configure [access controls](/docs/guides/access-control.md).

- For password logins see: [`auth-password`](/keystonejs/auth-password/)
- For social logins using [Passport.js](http://www.passportjs.org/) see: [`auth-passport`](/keystonejs/auth-passport/)
- For password logins see: [`auth-password`](/packages/auth-password/README.md)
- For social logins using [Passport.js](http://www.passportjs.org/) see: [`auth-passport`](/packages/auth-passport/README.md)

## Usage

Expand Down
48 changes: 24 additions & 24 deletions docs/api/create-list.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Create List
order: 2
[meta]-->

# createList(name, options)
# `keystone.createList(name, options)`

## Usage

Expand All @@ -16,25 +16,25 @@ keystone.createList('Post', {

### Config

| Option | Type | Default | Description |
| --------------- | ----------------------------------- | ----------------------------- | -------------------------------------------------------------- |
| `fields` | `Object` | | Defines the fields in a list. |
| `schemaDoc` | `String` | | A description for the list. Used in the Admin UI. |
| `hooks` | `Object` | `{}` | Functions to be called during list operations. |
| `label` | `String` | `listName` | Overrides label for the list in the AdminUI. |
| `labelField` | `String` | `name` | Specify a field to use as a label for individual list items. |
| `labelResolver` | `Function` | Resolves `labelField` or `id` | Function to resolve labels for individual list items. |
| `access` | `Function` \| `Object` \| `Boolean` | `true` | [Access control](/guides/access-control) options for the list. |
| `adapterConfig` | `Object` | | Override the adapter config options for a specific list. |
| `itemQueryName` | `String` | | Changes the _item_ name in GraphQL queries and mutations. |
| `listQueryName` | `String` | | Changes the _list_ name in GraphQL queries and mutations. |
| `singular` | `String` | | Specify a singular noun for `Keystone` to use for the list. |
| `plural` | `String` | | Specify a plural for `Keystone` to use for the list. |
| `path` | `String` | | Changes the path in the Admin UI. |
| `plugins` | `Array` | `[]` | An array of `plugins` that can modify the list config. |
| `queryLimits` | `Object` | `{}` | Configures list-level query limits. |
| `cacheHint` | `Object` | `{}` | Configures a default caching hint for list. |
| `adminConfig` | `Object` | `{}` | Options for the AdminUI. |
| Option | Type | Default | Description |
| --------------- | ----------------------------------- | ----------------------------- | ---------------------------------------------------------------------- |
| `fields` | `Object` | | Defines the fields in a list. |
| `schemaDoc` | `String` | | A description for the list. Used in the Admin UI. |
| `hooks` | `Object` | `{}` | Functions to be called during list operations. |
| `label` | `String` | `listName` | Overrides label for the list in the AdminUI. |
| `labelField` | `String` | `name` | Specify a field to use as a label for individual list items. |
| `labelResolver` | `Function` | Resolves `labelField` or `id` | Function to resolve labels for individual list items. |
| `access` | `Function` \| `Object` \| `Boolean` | `true` | [Access control](/docs/guides/access-control.md) options for the list. |
| `adapterConfig` | `Object` | | Override the adapter config options for a specific list. |
| `itemQueryName` | `String` | | Changes the _item_ name in GraphQL queries and mutations. |
| `listQueryName` | `String` | | Changes the _list_ name in GraphQL queries and mutations. |
| `singular` | `String` | | Specify a singular noun for `Keystone` to use for the list. |
| `plural` | `String` | | Specify a plural for `Keystone` to use for the list. |
| `path` | `String` | | Changes the path in the Admin UI. |
| `plugins` | `Array` | `[]` | An array of `plugins` that can modify the list config. |
| `queryLimits` | `Object` | `{}` | Configures list-level query limits. |
| `cacheHint` | `Object` | `{}` | Configures a default caching hint for list. |
| `adminConfig` | `Object` | `{}` | Options for the AdminUI. |

### `fields`

Expand All @@ -50,7 +50,7 @@ keystone.createList('Post', {
});
```

See: [Fields](/keystonejs/fields/) for more information on configuring field options.
See: [Fields](/packages/fields/README.md) for more information on configuring field options.

### `schemaDoc`

Expand Down Expand Up @@ -128,9 +128,9 @@ keystone.createList('User', {

### `access`

[Access control](/guides/access-control) options for the list.
[Access control](/docs/guides/access-control.md) options for the list.

Options for `create`, `read`, `update` and `delete` - can be a function, GraphQL where clause or Boolean. See the [access control API documentation](/api/access-control) for more details.
Options for `create`, `read`, `update` and `delete` - can be a function, GraphQL where clause or Boolean. See the [access control API documentation](/docs/api/access-control.md) for more details.

#### Usage

Expand Down Expand Up @@ -304,7 +304,7 @@ This provides a method for packaging features that can be applied to multiple li

Configuration for limiting the kinds of queries that can be made against the list, to avoid queries that might overload the server.

See also [global query limits on the Keystone object](/api/keystone#query-limits).
See also [global query limits on the Keystone object](/packages/keystone/README.md#querylimits).

- `maxResults`: maximum number of results that can be returned in a query (or subquery)

Expand Down
Loading

0 comments on commit 0a510ec

Please sign in to comment.