Skip to content

Commit 4208473

Browse files
authored
Move the docs to WordPress.org (#3381)
You've served us well, docutron, but it's time to move. The docs now live here: https://wordpress.org/gutenberg/handbook/
1 parent c24338c commit 4208473

31 files changed

+146
-1078
lines changed

.travis.yml

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -63,16 +63,3 @@ jobs:
6363
- npm install || exit 1
6464
- npm run build || exit 1
6565
- ./bin/run-e2e-tests.sh || exit 1
66-
67-
before_deploy:
68-
- npm install
69-
- cd docutron
70-
- npm install
71-
- cd ../
72-
- npm run docs-build
73-
74-
deploy:
75-
provider: surge
76-
project: ./docutron/build/
77-
skip_cleanup: true
78-
domain: gutenberg-devdoc.surge.sh

CONTRIBUTING.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -102,18 +102,6 @@ If you'd like to contribute to the design or front-end, feel free to contribute
102102

103103
### Contribute to the Documentation
104104

105-
We're using an internal tool called `docutron` to generate the [Gutenberg Documentation Website](http://gutenberg-devdoc.surge.sh). You can run a local version of this website by cloning the repository and then running :
105+
Documentation is automatically synced from master to the [Gutenberg Documentation Website](https://wordpress.org/gutenberg/handbook/) every 15 minutes.
106106

107-
```bash
108-
npm install && npm run docs-start
109-
```
110-
111-
To add a new documentation page, you'll have to create a markdown file in the [docs](https://github.com/WordPress/gutenberg/tree/master/docs) folder and create a story referencing this file in the docs [stories file](https://github.com/WordPress/gutenberg/blob/master/docs/index.js) like so:
112-
113-
```js
114-
addStory( {
115-
name: 'story-name', // used in the url
116-
title: 'Story Title',
117-
markdown: require( './story-markdown-file.md' ),
118-
} );
119-
```
107+
To add a new documentation page, you'll have to create a Markdown file in the [docs](https://github.com/WordPress/gutenberg/tree/master/docs) folder and add an item to the [manifest file](https://github.com/WordPress/gutenberg/blob/master/docs/manifest.json).

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This is the development hub for the <a href="https://make.wordpress.org/core/201
1212
1313
WordPress already supports a large amount of "blocks", but doesn't surface them very well, nor does it give them much in the way of layout options. By embracing the blocky nature of rich post content, we will surface the blocks that already exist, as well as provide more advanced layout options for each of them. This will allow you to easily compose beautiful posts like <a href="http://moc.co/sandbox/example-post/">this example</a>.
1414

15-
Check out the <a href="https://github.com/WordPress/gutenberg/blob/master/docs/faq.md">FAQ</a> for answers to the most common questions about the project.
15+
Check out the <a href="https://wordpress.org/gutenberg/handbook/reference/faq/">FAQ</a> for answers to the most common questions about the project.
1616

1717
## Contributors
1818

@@ -24,7 +24,7 @@ Gutenberg is built by many contributors and volunteers. Please see the full list
2424
- <a href="https://make.wordpress.org/core/2017/05/05/editor-how-little-blocks-work/">How Blocks Work</a>
2525
- <a href="https://github.com/Automattic/wp-post-grammar">WP Post Grammar Parser</a>
2626
- <a href="https://make.wordpress.org/core/tag/gutenberg/">Development updates on make.wordpress.org</a>
27-
- <a href="http://gutenberg-devdoc.surge.sh/">Documentation: Creating Blocks, Reference, and Guidelines</a>
27+
- <a href="https://wordpress.org/gutenberg/handbook/">Documentation: Creating Blocks, Reference, and Guidelines</a>
2828

2929
## How You Can Contribute
3030

blocks/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ to describe the behavior of your custom block.
5252
Note that all JavaScript code samples in this document are enclosed in a
5353
function that is evaluated immediately afterwards. We recommend using either
5454
ES6 modules
55-
[as used in this project](https://github.com/WordPress/gutenberg/blob/master/docs/coding-guidelines.md#imports)
55+
[as used in this project](https://wordpress.org/gutenberg/handbook/reference/coding-guidelines/#imports)
5656
(documentation on setting up a plugin with Webpack + ES6 modules coming soon)
5757
or these
5858
["immediately-invoked function expressions"](https://en.wikipedia.org/wiki/Immediately-invoked_function_expression)
@@ -237,7 +237,7 @@ editor interface where blocks are implemented.
237237
- `attributes: Object | Function` - An object of attribute schemas, where the
238238
keys of the object define the shape of attributes, and each value an object
239239
schema describing the `type`, `default` (optional), and
240-
[`source`](http://gutenberg-devdoc.surge.sh/reference/attributes/)
240+
[`source`](https://wordpress.org/gutenberg/handbook/reference/attributes/)
241241
(optional) of the attribute. If `source` is omitted, the attribute is
242242
serialized into the block's comment delimiters. Alternatively, define
243243
`attributes` as a function which returns the attributes object.

blocks/editable/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ export default class Editable extends Component {
8484
`Invalid value of type ${ typeof value } passed to Editable ` +
8585
'(expected array). Attribute values should be sourced using ' +
8686
'the `children` source when used with Editable.\n\n' +
87-
'See: http://gutenberg-devdoc.surge.sh/reference/attributes/#children'
87+
'See: https://wordpress.org/gutenberg/handbook/reference/attributes/#children'
8888
);
8989
}
9090

docs/design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,4 +220,4 @@ If you'd like to contribute, you can download a Sketch file of the Gutenberg moc
220220

221221
A pattern file is here: **<a href="https://cloudup.com/c0Q8RQDHByq">Download Pattern Sketch file</a>**
222222

223-
Be sure to also read <a href="https://github.com/WordPress/gutenberg/blob/master/docs/faq.md">the FAQ</a>, and <a href="http://gutenberg-devdoc.surge.sh/">how to build blocks</a>.
223+
Be sure to also read <a href="https://wordpress.org/gutenberg/handbook/reference/faq/">the FAQ</a>, and <a href="https://wordpress.org/gutenberg/handbook/">how to build blocks</a>.

docs/faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Gutenberg will work in modern browsers, and Internet Explorer 11.
5151

5252
## How do I make my own block?
5353

54-
The API for creating blocks is a crucial aspect of the project. We are working on improved documentation and tutorials. Check out the [Creating Block Types](http://gutenberg-devdoc.surge.sh/blocks/) section to get started.
54+
The API for creating blocks is a crucial aspect of the project. We are working on improved documentation and tutorials. Check out the [Creating Block Types](https://wordpress.org/gutenberg/handbook/blocks/) section to get started.
5555

5656
## Does Gutenberg involve editing posts/pages in the front-end?
5757

@@ -97,7 +97,7 @@ Blocks will be able to provide base structural CSS styles, and themes can add st
9797

9898
Other features, like the new _wide_ and _full-wide_ alignment options, will simply be CSS classes applied to blocks that offer this alignment. We are looking at how a theme can opt in to this feature, for example using `add_theme_support`.
9999

100-
*See:* [Theme Support](http://gutenberg-devdoc.surge.sh/reference/theme-support/)
100+
*See:* [Theme Support](https://wordpress.org/gutenberg/handbook/reference/theme-support/)
101101

102102
## How will editor styles work?
103103

@@ -146,7 +146,7 @@ If you would like to contribute to the accessibility of Gutenberg, we can always
146146

147147
## Are there any design resources for Gutenberg?
148148

149-
Yes, primarily https://github.com/WordPress/gutenberg/blob/master/docs/design.md
149+
Yes, primarily https://wordpress.org/gutenberg/handbook/reference/design-principles/
150150

151151
We are still adding more documentation.
152152

docs/index.js

Lines changed: 0 additions & 152 deletions
This file was deleted.

0 commit comments

Comments
 (0)