Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Your checklist for this pull request

Please review the [guidelines for contributing](https://github.com/auth0/docs#contributing) to this repository.
Please review the [guidelines for contributing](https://github.com/auth0/docs#contributing) for this repository.

- [ ] Content conforms to our [Contributing Guidelines](https://github.com/auth0/docs#contributing-guidelines)
- [ ] If applicable, you have added details to the [update feed](https://github.com/auth0/docs/tree/master/updates)
Expand Down
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,24 @@ This is the repository for the Auth0 documentation.
* Always use absolute links from the root of the site. Note, that your links should NOT start with `/docs` or any other base path. If the site is hosted with a base like on `auth0.com/docs` the links will be corrected at runtime.
* Do not hard code links to auth0 sites like `docs.auth0.com`, `manage.auth0.com`, etc. Use variables instead such as `${uiUrl}`
* Name files with all lowercase using dashes (-) to separate words. If using a year in the file name it should be in the format YYYY-MM-DD. For example, `this-is-my-file.md` or `this-is-a-title-2015-10-01.md`.
* Do not store images in external locations like Dropbox, CloudUp, or the Auth0 CDN. Link to images in this repo using `![](/media/folder/image-name.png)`. The image will get automatically uploaded to the CDN and the link will be transformed.
* Try to keep images to no more than 750 pixels wide
* Do not store images in external locations like Dropbox, CloudUp, or the Auth0 CDN. Link to images in this repo using `![](/media/folder/image-name.png)`. The image will be automatically uploaded to the CDN and the link will be transformed.
* Please keep images less than 750 pixels wide
* Run all images through [TinyPNG](https://tinypng.com/).

## Contributing

### Reusing content
You can create document fragments that can be reused in other documents in order to avoid duplication of content. The process of including another document is shown below.

First, create your fragment document. The convention for this is to name fragments with an underscore like `_mydocument.md`.
First, create your document fragment. The convention for this is to name fragments with an underscore like `_mydocument.md`.

After you create your markdown document you can reference it another document with the relative path.
After you create your markdown document you can reference it another document with the relative path:

```
<%= include('../_mydocument.md') %>
```

Additionally, you can send a context to the included document.
Additionally, you can send a context to the included document:

```
<%= include('../_mydocument.md', { key: 'value', something: true }) %>
Expand All @@ -34,7 +34,7 @@ Additionally, you can send a context to the included document.
Markdown on this site confirms to the [CommonMark spec](http://commonmark.org/). Additionally, there are a few special markdown features available as described below.

#### Warning banner
You can add a warning banner to the top of a page to notify that a page is deprecated or other similar messages.
You can, for example, add a warning banner to the top of a page to notify the reader that a page is deprecated or to convey similar messages.

```
::: warning-banner
Expand All @@ -59,7 +59,7 @@ Panel content
Panel content
:::

::: panel-danger This is a dangerous
::: panel-danger This is dangerous
Panel content
:::

Expand All @@ -69,7 +69,7 @@ Panel content
```

#### HTTP Request Snippets
You can add a [HAR request format](http://www.softwareishard.com/blog/har-12-spec/#request) snippet to make an example HTTP request availible in a variety of languages. This will generate a tab view showing how to make the HTTP request in many languages.
You can add a [HAR request format](http://www.softwareishard.com/blog/har-12-spec/#request) snippet to make an example HTTP request available in a variety of languages. This will generate a tab view showing how to make the HTTP request in many languages.

> Note, you need to set the language type to `har` for this to work. View this raw markdown document for an example.

Expand Down Expand Up @@ -105,11 +105,11 @@ You can add a [HAR request format](http://www.softwareishard.com/blog/har-12-spe


### Screenshots
On Mac OS X screenshots need to be taken with Chrome, taking into account the following:
On Mac OS X screenshots need to be made with Chrome, taking the following into account:

1. The browser cannot show any plugins, customizations, or bookmarks
1. The browser cannot be in incognito mode
1. The browser needs to be resized to the standard size. Using the below script:
1. The browser needs to be resized to the standard size. Using the following script:

```bash
osascript -e 'tell application "Chrome" to set the bounds of the front window to {100, 150, 1200, 900}'
Expand All @@ -127,15 +127,15 @@ On Mac OS X screenshots need to be taken with Chrome, taking into account the fo
## Test Procedures
When testing a document or tutorial below are several areas to look for.

1. Ensure that the code in the tutorials is correct and functions as expected
1. Ensure that the code in the tutorials is correct and functions as expected.
1. Ensure that the steps (1..n) are in an order that makes sense and that there are no missing or duplicate steps.
1. Check for broken links
1. Check for old screenshots (both in auth0's dashboard/product and on referenced third-party sites)
1. Ensure that the code in the seed project that you download functions as expected
1. Check for outdated dependencies (both auth0 dependencies and third-party i.e. node modules, nuget packages, gems, etc.)
1. Check for broken links.
1. Check for old screenshots (both in auth0's dashboard/product and on referenced third-party sites).
1. Ensure that the code in the seed project that you download functions as expected.
1. Check for outdated dependencies (both auth0 dependencies and third-party i.e. node modules, nuget packages, gems, etc.).

## Review Apps
If you have access to the Auth0 heroku account, you can create a preview release for you pull requests. To do so, login to Heroku and open the `auth0-docs-content` pipeline.
If you have access to the Auth0 heroku account, you can create a preview release for your pull requests. To do so, login to Heroku and open the `auth0-docs-content` pipeline.

1. Next find the Review App for your pull request and click the "Create Review App" button.
![Create Review App](media/readme/create_review_app.png)
Expand Down Expand Up @@ -218,9 +218,9 @@ All document content is accessible through the docs API as well as through regul

To request a document in embedded format (i.e. no template html) to embed externally simply append `?e=1` to any url.

To request a document in the framed format (i.e. no header, footer, or naviation) to use in a window popup or an iframe simply append `?framed=1` to any url.
To request a document in the framed format (i.e. no header, footer, or navigation) to use in a window popup or an iframe simply append `?framed=1` to any url.

To request content in JSON or JSONP format simply pass the header `Accept: 'application/json'` and optionally specify a ``?callback=foo` query parameter for JSONP.
To request content in JSON or JSONP format simply pass the header `Accept: 'application/json'` and optionally specify a `?callback=foo` query parameter for JSONP.

In the JSON or JSONP responses you can also request the document metadata by appending `?m=1` to the query.

Expand All @@ -235,7 +235,7 @@ Response:
{
"title": "{title}",
"content": "{<pre><code class="{class}">{code}</code></pre> }",
"hash": "{hash}"
"hash": "{hash}",
"additional_metadata": ""
}
```
Expand All @@ -247,7 +247,7 @@ ${snippet('{hash}')}
```

## Connections
Connections are available both through the API and to use in markdown docs.
Connections are available both through the API and for use in markdown docs.

Access via API:

Expand Down Expand Up @@ -284,7 +284,7 @@ When writing docs you can use the following variables instead of hard coding the
| `auth0js_url` | The url to the auth0.js CDN location. | |
| `auth0js_url_no_scheme` | The url to the auth0.js CDN location without the 'https:'. | |
| `auth0_angular_url` | The url to the auth0 angular script CDN location. | |
| `auth0_angular_url_no_scheme` | The url to the auth0 angular script in the CDN location without the 'https://'. | |
| `auth0_angular_url_no_scheme` | The url to the auth0 angular script in the CDN location without the 'https://'. | |
| `widget_url` | The url to the Lock script CDN location. | |
| `widget_url_no_scheme` | The url to the Lock script CDN location without the 'https:'. | |
| `lock_passwordless_url` | The url to the Passwordless Lock script CDN location. | |
Expand All @@ -294,8 +294,8 @@ When writing docs you can use the following variables instead of hard coding the

| Variable | Description | Default Value |
| :--------------------- | :------------------------------------------------- | :------------------------------------- |
| `account.appName` | The name of the current Auth0 app. | `YOUR_APP_NAME' |
| `account.tenant` | The name of the current Auth0 tenant. | `YOUR_TENANT' |
| `account.appName` | The name of the current Auth0 app. | `YOUR_APP_NAME` |
| `account.tenant` | The name of the current Auth0 tenant. | `YOUR_TENANT` |
| `account.namespace` | The name of the current Auth0 namespace. | `YOUR_NAMESPACE` |
| `account.clientId` | The Client ID of the current Auth0 app. | `YOUR_CLIENT_ID` |
| `account.clientSecret` | The Client Secret of the current Auth0 app. | `YOUR_CLIENT_SECRET` |
Expand Down
12 changes: 6 additions & 6 deletions STYLEGUIDE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Auth0 Style Guide #

This style guide will cover the terminology and content specific to Auth0, along with some comments on common writing issues.
For general software-industry styles and terminology, see the [Microsoft Manual of Style](https://eucalyptus.atlassian.net/wiki/download/attachments/76611622/microsoft_manual_of_style_fourth_edition.pdf?version=2&modificationDate=1424379604164&api=v2).
This style guide will cover the terminology and content specific to Auth0, along with some comments on common writing issues. For general software-industry styles and terminology, see the [Microsoft Manual of Style](https://eucalyptus.atlassian.net/wiki/download/attachments/76611622/microsoft_manual_of_style_fourth_edition.pdf?version=2&modificationDate=1424379604164&api=v2).

## Voice

Expand All @@ -15,6 +14,8 @@ Use of gerunds makes a statement more passive. To discuss actions the user must

Abbreviations should be avoided. Avoid the use of e.g., for example. Instead, use "for example." The idea is to prevent the reader from having to stop and think about what you mean. It may seem like it just takes a second, but it is similar to tuning your web site performance. You want your site to perform quickly and smoothly. Similarly, you want your content to flow smoothly, uninterrupted by questions the reader must ask himself regarding your intentions.

Avoid contractions wherever possible. Contractions are generally used in spoken language and therefore carry a sense of informality or even laziness.

The use of should versus must and other ambivalent statements must be avoided. If something is required, be definite about it and tell the user it "must" be performed.

## Compound words
Expand All @@ -27,14 +28,13 @@ Other commonly encountered compound words include server side and client side. T
## Punctuation

<b>Colons</b>
Colons are useful when you are directly referring to an example, such as "here is the relevant code:"
Colons are useful when you are directly referring to an example, such as "Here is the relevant code:"

<b>Adjectives</b>
Hyphens are used between adjectives and the verb they modify if and only if the adjective does not end in "ly." Therefore, "commonly used adjectives" is not hyphenated, while "oft-quoted phrase" is.

<b>Punctuation and quotes</b>
In American English, but not British English, punctuation properly belongs inside quotation marks. Therefore, if you incorporate a quote into a sentence, either within or at the end, such as our editor said "You must end quotations with periods inside the quotation marks," you would construct the quotation as you see here, with the comma inside the quotation marks.
If this becomes an issue when quoting code because the code does not include the punction mark in question, do not place the punctuation mark inside the quotes.
Punctuation belongs inside quotation marks in US American English, but not British English. Therefore, if you incorporate a quote within or at the end of a sentence, such as "You must end quotations with periods inside the quotation marks," you would construct the quotation as you see here, with the comma inside the quotation marks. If this becomes an issue when quoting code because the code does not include the punctuation mark in question, do not place the punctuation mark inside the quotes.

## Formatting
Do not use block quote style for notes or warnings. It makes the note or warning too prominent.
Do not use block quote style for notes or warnings. This makes the note or warning too prominent.
Loading