docs: publish with gitbook

.gitignore

@@ -125,7 +125,9 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
-# End of https://www.gitignore.io/api/macos,windows,linux,node
-
+# Lockfiles
 package-lock.json
 yarn.lock
+
+# Gitbook
+_book

SUMMARY.md

@@ -0,0 +1,39 @@
+# Summary
+
+## About
+- [Highlights](README.md#highlights)
+- [How does it work?](README.md#how-does-it-work)
+
+## Usage
+- [Installation](docs/usage/installation.md#installation)
+- [CI Configuration](docs/usage/ci-configuration.md#ci-configuration)
+- [Configuration](docs/usage/configuration.md#configuration)
+- [Plugins](docs/usage/plugins.md)
+- [Shareable configurations](docs/usage/shareable-configurations.md)
+
+## Extending
+- [Plugins](docs/extending/plugins-list.md)
+- [Shareable configuration](docs/extending/shareable-configurations-list.md)
+
+## Recipes
+- [CI configurations](docs/recipes/README.md)
+	- [CircleCI 2.0 workflows](docs/recipes/circleci-workflows.md)
+	- [Travis CI](docs/recipes/travis.md)
+	- [Travis CI with build stages](docs/recipes/travis-build-stages.md)
+	- [GitLab CI](docs/recipes/gitlab-ci.md)
+- [Package managers and languages](docs/recipes/README.md)
+
+## Developer guide
+- [Plugin](docs/developer-guide/plugin.md)
+- [Shareable configuration](docs/developer-guide/shareable-configuration.md)
+
+## Resources
+- [Videos](docs/resources.md#videos)
+- [Articles](docs/resources.md#articles)
+- [Tutorials](docs/resources.md#tutorials)
+
+## Support
+- [Frequently Asked Questions](docs/support/FAQ.md)
+- [Troubleshooting](docs/support/troubleshooting.md)
+- [Node version requirement](docs/support/node-version.md)
+- [Node Support Policy](docs/support/node-support-policy.md)

bin/semantic-release.js

@@ -12,7 +12,7 @@ if (!semver.satisfies(process.version, pkg.engines.node)) {
   console.error(
     `[semantic-release]: node version ${pkg.engines.node} is required. Found ${process.version}.
 
-See https://github.com/semantic-release/semantic-release/blob/caribou/docs/node-version.md for more details and solutions.`
+See https://github.com/semantic-release/semantic-release/blob/caribou/docs/support/node-version.md for more details and solutions.`
   );
   process.exit(1);
 }

book.json

@@ -0,0 +1,8 @@
+{
+    "plugins" : ["github"],
+    "pluginsConfig": {
+      "github": {
+          "url": "https://github.com/semantic-release/semantic-release"
+      }
+    }
+}

docs/README.md

@@ -1,7 +1,8 @@
 # semantic-release documentation
 
-- [Plugins](plugins.md#semantic-release-plugins) - List of semantic-release plugins
-- [Shareable configurations](shareable-configurations.md#semantic-release-shareable-configurations) - List of semantic-release shareable configs
-- [Developer Guide](developer-guide/README.md#semantic-release-developer-guide) - The essentials of writing a semantic-release plugin or shareable config
-- [Recipes](recipes/README.md#semantic-release-recipes) - Community written recipes for common semantic-release use-cases
-- [Troubleshooting](troubleshooting.md#troubleshooting-semantic-release) - Community written troubleshooting guide to help with common semantic-release issues
+- [Usage](usage/README.md) - **semantic-release** installation and configuration
+- [Extending][extending/README.md]- Extending **semantic-release** with plugins and shareable configurations
+- [Recipes](recipes/README.md) - Community written recipes for common **semantic-release** use-cases
+- [Developer Guide](developer-guide/README.md) - The essentials of writing a **semantic-release** plugin or shareable configurations
+- [Resources](resources.md) - Videos, articles and tutorials
+- [Support](support/README.md) - FAQ and troubleshooting

docs/developer-guide/README.md

@@ -1 +1,4 @@
-# semantic-release Developer Guide
+# Developer guide
+
+- [Plugins](plugin.md)
+- [Shareable configuration](shareable-configuration.md)

docs/developer-guide/plugin.md

@@ -1 +1 @@
-# semantic-release plugin development
+# Plugin developer guide

docs/developer-guide/shareable-configuration.md

@@ -1 +1 @@
-# semantic-release shareable config development
+# Shareable configuration developer guide

docs/extending/README.md

@@ -0,0 +1,4 @@
+# Extending semantic-release
+
+- [Plugins list](plugins-list.md)
+- [Shareable configuration list](shareable-configurations-list.md)

docs/extending/plugins-list.md

@@ -0,0 +1,33 @@
+# Plugins list
+
+## Default plugins
+
+- [@semantic-release/github](https://github.com/semantic-release/github)
+  - [verifyConditions](https://github.com/semantic-release/github#verifyconditions): Verify the presence and the validity of the GitHub authentication and release configuration
+  - [publish](https://github.com/semantic-release/github#publish): Publish a [GitHub release](https://help.github.com/articles/about-releases)
+- [@semantic-release/npm](https://github.com/semantic-release/npm)
+  - [verifyConditions](https://github.com/semantic-release/npm#verifyconditions): Verify the presence and the validity of the npm authentication and release configuration
+  - [getLastRelease](https://github.com/semantic-release/npm#getlastrelease): Determine the last release of the package on the npm registry
+  - [publish](https://github.com/semantic-release/npm#publish): Publish the package on the npm registry
+
+## Official plugins
+
+- [@semantic-release/gitlab](https://github.com/semantic-release/gitlab)
+  - [verifyConditions](https://github.com/semantic-release/gitlab#verifyconditions): Verify the presence and the validity of the GitLab authentication and release configuration
+  - [publish](https://github.com/semantic-release/gitlab#publish): Publish a [GitLab release](https://docs.gitlab.com/ce/workflow/releases.html)
+- [@semantic-release/git](https://github.com/semantic-release/git)
+  - [verifyConditions](https://github.com/semantic-release/git#verifyconditions): Verify the presence and the validity of the Git authentication and release configuration
+  - [getLastRelease](https://github.com/semantic-release/git#getlastrelease): Determine the last release via Git tags on the repository
+  - [publish](https://github.com/semantic-release/git#publish): Push a release commit and tag, including configurable files
+- [@semantic-release/changelog](https://github.com/semantic-release/changelog)
+  - [verifyConditions](https://github.com/semantic-release/changelog#verifyconditions): Verify the presence and the validity of the configuration
+  - [publish](https://github.com/semantic-release/changelog#publish): Create or update the changelog file in the local project repository
+- [@semantic-release/exec](https://github.com/semantic-release/exec)
+  - [verifyConditions](https://github.com/semantic-release/exec#verifyconditions): Execute a shell command to verify if the release should happen
+  - [getLastRelease](https://github.com/semantic-release/exec#getlastrelease): Execute a shell command to determine the last release
+  - [analyzeCommits](https://github.com/semantic-release/exec#analyzecommits): Execute a shell command to determine the type of release
+  - [verifyRelease](https://github.com/semantic-release/exec#verifyrelease): Execute a shell command to verifying a release that was determined before and is about to be published.
+  - [generateNotes](https://github.com/semantic-release/exec#analyzecommits): Execute a shell command to generate the release note
+  - [publish](https://github.com/semantic-release/exec#publish): Execute a shell command to publish the release.
+
+## Community plugins

docs/shareable-configurations.md → docs/extending/shareable-configurations-list.md

@@ -1,7 +1,7 @@
-# semantic-release shareable configurations
+# Shareable configurations list
 
 ## Official configurations
-- [@semantic-release/apm-config](https://github.com/semantic-release/apm-config) - :atom: semantic-release shareable config for releasing atom packages
-- [@semantic-release/gitlab-config](https://github.com/semantic-release/gitlab-config) - :fox_face:  semantic-release shareable config for GitLab
+- [@semantic-release/apm-config](https://github.com/semantic-release/apm-config) - semantic-release shareable configuration for releasing atom packages
+- [@semantic-release/gitlab-config](https://github.com/semantic-release/gitlab-config) - semantic-release shareable configuration for GitLab
 
 ## Community configurations

docs/recipes/README.md

@@ -1,4 +1,4 @@
-# semantic-release recipes
+# Recipes
 
 ## CI configurations
 - [CircleCI 2.0 workflows](circleci-workflows.md)

docs/recipes/gitlab-ci.md

@@ -2,19 +2,19 @@
 
 ## Environment variables
 
-The [Authentication](../../README.md#authentication) environment variables can be configured with [Secret variables](https://docs.gitlab.com/ce/ci/variables/README.html#secret-variables).
+The [Authentication](../usage/ci-configuration.md#authentication) environment variables can be configured with [Secret variables](https://docs.gitlab.com/ce/ci/variables/README.html#secret-variables).
 
 ## Node project configuration
 
 GitLab CI supports [Pipelines](https://docs.gitlab.com/ee/ci/pipelines.html) allowing to test on multiple Node versions and publishing a release only when all test pass.
 
-**Note**: The publish pipeline must run a [Node >= 8 version](../../README.md#why-does-semantic-release-require-node-version--8).
+**Note**: The publish pipeline must run a [Node >= 8 version](../support/FAQ.md#why-does-semantic-release-require-node-version--8).
 
 ### `.gitlab-ci.yml` configuration for Node projects
 
-This example is a minimal configuration for semantic-release with a build running Node 4, 6 and 8 on Linux. See [GitLab CI - Configuration of your jobs with .gitlab-ci.yml](https://docs.gitlab.com/ee/ci/yaml/README.html) for additional configuration options.
+This example is a minimal configuration for **semantic-release** with a build running Node 4, 6 and 8 on Linux. See [GitLab CI - Configuration of your jobs with .gitlab-ci.yml](https://docs.gitlab.com/ee/ci/yaml/README.html) for additional configuration options.
 
-**Note**: The`semantic-release` execution command varies depending if you are using a [local](../../README.md#local-installation) or [global](../../README.md#global-installation) semantic-release installation.
+**Note**: The`semantic-release` execution command varies depending if you are using a [local](../usage/installation.md#local-installation) or [global](../usage/installation.md#global-installation) **semantic-release** installation.
 
 ```yaml
 # The release pipeline will run only if all jobs in the test pipeline are successful
@@ -57,7 +57,7 @@ publish:
 
 ### `package.json` configuration
 
-A `package.json` is required only for [local semantic-release installations](../../README.md#local-installation).
+A `package.json` is required only for [local](../usage/installation.md#local-installation) **semantic-release** installation.
 
 ```json
 {