revert: docs: made doc file org clearer and augmented content

This reverts commit 5a5eaec.
semantic-release · Aug 22, 2019 · 5e41dc8 · 5e41dc8
1 parent ce3d1bc
commit 5e41dc8
Show file tree

Hide file tree

Showing 34 changed files with 252 additions and 352 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -21,7 +21,7 @@ Help us keep **semantic-release** open and inclusive. Please read and follow our
 
 ### Improve documentation
 
-As a **semantic-release** user, you are the perfect candidate to help us improve our documentation: typo corrections, clarifications, more examples, new [recipes](docs/03-recipes/README.md), etc. Take a look at the [documentation issues that need help](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22+label%3Adocs+).
+As a **semantic-release** user, you are the perfect candidate to help us improve our documentation: typo corrections, clarifications, more examples, new [recipes](docs/recipes/README.md), etc. Take a look at the [documentation issues that need help](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22+label%3Adocs+).
 
 Please follow the [Documentation guidelines](#documentation).
 
@@ -37,7 +37,7 @@ Confirmed bugs and ready-to-implement features are marked with the [help wanted
 
 ## Using the issue tracker
 
-The issue tracker is the channel for [bug reports](#bug-report), [features requests](#feature-request) and [submitting pull requests](#submitting-a-pull-request) only. Please use the [Support](docs/05-support/README.md) and [Get help](README.md#get-help) sections for support, troubleshooting and questions.
+The issue tracker is the channel for [bug reports](#bug-report), [features requests](#feature-request) and [submitting pull requests](#submitting-a-pull-request) only. Please use the [Support](docs/support/README.md) and [Get help](README.md#get-help) sections for support, troubleshooting and questions.
 
 Before opening an issue or a Pull Request, please use the [GitHub issue search](https://github.com/issues?utf8=%E2%9C%93&q=user%3Asemantic-release) to make sure the bug or feature request hasn't been already reported or fixed.
 
@@ -51,7 +51,7 @@ Feature requests are welcome, but take a moment to find out whether your idea fi
 
 ### New plugin request
 
-[Plugins](docs/01-usage/plugins.md) are a great way to extend **semantic-release** capabilities, integrate with other systems and support new project type. Please provide as much detail and context as possible and fill the information requested in the [New plugin request template](https://github.com/semantic-release/semantic-release/issues/new?template=plugin-request.md).
+[Plugins](docs/usage/plugins.md) are a great way to extend **semantic-release** capabilities, integrate with other systems and support new project type. Please provide as much detail and context as possible and fill the information requested in the [New plugin request template](https://github.com/semantic-release/semantic-release/issues/new?template=plugin-request.md).
 
 ## Submitting a Pull Request
 

diff --git a/README.md b/README.md
@@ -39,18 +39,18 @@ This removes the immediate connection between human emotions and version numbers
 - New features and fixes are immediately available to users
 - Notify maintainers and users of new releases
 - Use formalized commit message convention to document changes in the codebase
-- Integrate with your [continuous integration workflow](docs/03-recipes/README.md#ci-configurations)
+- Integrate with your [continuous integration workflow](docs/recipes/README.md#ci-configurations)
 - Avoid potential errors associated with manual releases
-- Support any [package managers and languages](docs/03-recipes/README.md#package-managers-and-languages) via [plugins](docs/01-usage/plugins.md)
-- Simple and reusable configuration via [shareable configurations](docs/01-usage/shareable-configurations.md)
+- Support any [package managers and languages](docs/recipes/README.md#package-managers-and-languages) via [plugins](docs/usage/plugins.md)
+- Simple and reusable configuration via [shareable configurations](docs/usage/shareable-configurations.md)
 
 ## How does it work?
 
 ### Commit message format
 
 **semantic-release** uses the commit messages to determine the type of changes in the codebase. Following formalized conventions for commit messages, **semantic-release** automatically determines the next [semantic version](https://semver.org) number, generates a changelog and publishes the release.
 
-By default **semantic-release** uses [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines). The commit message format can be changed with the [`preset` or `config` options](docs/01-usage/configuration.md#options) of the [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer#options) and [@semantic-release/release-notes-generator](https://github.com/semantic-release/release-notes-generator#options) plugins.
+By default **semantic-release** uses [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines). The commit message format can be changed with the [`preset` or `config` options](docs/usage/configuration.md#options) of the [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer#options) and [@semantic-release/release-notes-generator](https://github.com/semantic-release/release-notes-generator#options) plugins.
 
 Tools such as [commitizen](https://github.com/commitizen/cz-cli), [commitlint](https://github.com/conventional-changelog/commitlint) or [semantic-git-commit-cli](https://github.com/JPeer264/node-semantic-git-commit-cli) can be used to help contributors and enforce valid commit messages.
 
@@ -78,48 +78,48 @@ If you need more control over the timing of releases you have a couple of option
 
 After running the tests, the command `semantic-release` will execute the following steps:
 
-| Step              | Step Hook            | Description                                                                                                                     |
-|-------------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------|
-| Verify Conditions | `verifyConditions`   | Verify all the conditions to proceed with the release.                                                                          |
-| Get last release  | N/A                  | Obtain the commit corresponding to the last release by analyzing [Git tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging). |
-| Analyze commits   | N/A                  | Determine the type of release based on the commits added since the last release.                                                |
-| Verify release    | `verifyRelease`      | Verify the release conformity.                                                                                                  |
-| Generate notes    | `generateNotes`      | Generate release notes for the commits added since the last release.                                                            |
-| Create Git tag    | N/A                  | Create a Git tag corresponding to the new release version.                                                                      |
-| Prepare           | `prepare`            | Prepare the release.                                                                                                            |
-| Publish           | `publish`            | Publish the release.                                                                                                            |
-| Notify            | `success`, `failure` | Notify of new releases or errors.                                                                                               |
+| Step              | Description                                                                                                                     |
+|-------------------|---------------------------------------------------------------------------------------------------------------------------------|
+| Verify Conditions | Verify all the conditions to proceed with the release.                                                                          |
+| Get last release  | Obtain the commit corresponding to the last release by analyzing [Git tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging). |
+| Analyze commits   | Determine the type of release based on the commits added since the last release.                                                |
+| Verify release    | Verify the release conformity.                                                                                                  |
+| Generate notes    | Generate release notes for the commits added since the last release.                                                            |
+| Create Git tag    | Create a Git tag corresponding to the new release version.                                                                      |
+| Prepare           | Prepare the release.                                                                                                            |
+| Publish           | Publish the release.                                                                                                            |
+| Notify            | Notify of new releases or errors.                                                                                               |
 
 ## Documentation
 
 - Usage
-  - [Getting started](docs/01-usage/01-getting-started.md)
-  - [Installation](docs/01-usage/installation.md#installation)
-  - [CI Configuration](docs/01-usage/ci-configuration.md#ci-configuration)
-  - [Configuration](docs/01-usage/configuration.md#configuration)
-  - [Plugins](docs/01-usage/plugins.md)
-  - [Shareable configurations](docs/01-usage/shareable-configurations.md)
+  - [Getting started](docs/usage/getting-started.md)
+  - [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/02-extending/plugins-list.md)
-  - [Shareable configuration](docs/02-extending/shareable-configurations-list.md)
+  - [Plugins](docs/extending/plugins-list.md)
+  - [Shareable configuration](docs/extending/shareable-configurations-list.md)
 - Recipes
-  - [CI pipelines recipes](docs/03-recipes/ci-pipelines-recipes.md)
-	- [CircleCI 2.0 workflows](docs/03-recipes/circleci-workflows.md)
-	- [Travis CI](docs/03-recipes/travis.md)
-	- [GitLab CI](docs/03-recipes/gitlab-ci.md)
-  - [Git hosted services](docs/03-recipes/git-hosted-services.md)
-	- [Git authentication with SSH keys](docs/03-recipes/git-auth-ssh-keys.md)
-  - [Package managers and languages](docs/03-recipes/package-managers-and-languages.md)
+  - [CI configurations](docs/recipes/ci-configurations.md)
+	- [CircleCI 2.0 workflows](docs/recipes/circleci-workflows.md)
+	- [Travis CI](docs/recipes/travis.md)
+	- [GitLab CI](docs/recipes/gitlab-ci.md)
+  - [Git hosted services](docs/recipes/git-hosted-services.md)
+	- [Git authentication with SSH keys](docs/recipes/git-auth-ssh-keys.md)
+  - [Package managers and languages](docs/recipes/package-managers-and-languages.md)
 - Developer guide
-  - [JavaScript API](docs/04-developer-guide/js-api.md)
-  - [Plugin development](docs/04-developer-guide/plugin.md)
-  - [Shareable configuration development](docs/04-developer-guide/shareable-configuration.md)
+  - [JavaScript API](docs/developer-guide/js-api.md)
+  - [Plugin development](docs/developer-guide/plugin.md)
+  - [Shareable configuration development](docs/developer-guide/shareable-configuration.md)
 - Support
-  - [Resources](docs/05-support/resources.md)
-  - [Frequently Asked Questions](docs/05-support/FAQ.md)
-  - [Troubleshooting](docs/05-support/troubleshooting.md)
-  - [Node version requirement](docs/05-support/node-version.md)
-  - [Node Support Policy](docs/05-support/node-support-policy.md)
+  - [Resources](docs/support/resources.md)
+  - [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)
 
 ## Get help
 

diff --git a/SUMMARY.md b/SUMMARY.md
@@ -1,34 +1,34 @@
 # Summary
 
 ## Usage
-- [Getting started](docs/01-usage/getting-started.md)
-- [Installation](docs/01-usage/installation.md#installation)
-- [CI Configuration](docs/01-usage/ci-configuration.md#ci-configuration)
-- [Configuration](docs/01-usage/configuration.md#configuration)
-- [Plugins](docs/01-usage/plugins.md)
-- [Shareable configurations](docs/01-usage/shareable-configurations.md)
+- [Getting started](docs/usage/getting-started.md)
+- [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)
 
-## Extensions
-- [Plugins](docs/02-extending/plugins-list.md)
-- [Shareable configuration](docs/02-extending/shareable-configurations-list.md)
+## Extending
+- [Plugins](docs/extending/plugins-list.md)
+- [Shareable configuration](docs/extending/shareable-configurations-list.md)
 
 ## Recipes
-- [CI pipelines recipes](docs/03-recipes/ci-pipelines-recipes.md)
-	- [CircleCI 2.0 workflows](docs/03-recipes/circleci-workflows.md)
-	- [Travis CI](docs/03-recipes/travis.md)
-	- [GitLab CI](docs/03-recipes/gitlab-ci.md)
-- [Git hosted services](docs/03-recipes/git-hosted-services.md)
-	- [Git authentication with SSH keys](docs/03-recipes/git-auth-ssh-keys.md)
-- [Package managers and languages](docs/03-recipes/package-managers-and-languages.md)
+- [CI configurations](docs/recipes/ci-configurations.md)
+	- [CircleCI 2.0 workflows](docs/recipes/circleci-workflows.md)
+	- [Travis CI](docs/recipes/travis.md)
+	- [GitLab CI](docs/recipes/gitlab-ci.md)
+- [Git hosted services](docs/recipes/git-hosted-services.md)
+	- [Git authentication with SSH keys](docs/recipes/git-auth-ssh-keys.md)
+- [Package managers and languages](docs/recipes/package-managers-and-languages.md)
 
 ## Developer guide
-- [JavaScript API](docs/04-developer-guide/js-api.md)
-- [Plugin development](docs/04-developer-guide/plugin.md)
-- [Shareable configuration development](docs/04-developer-guide/shareable-configuration.md)
+- [JavaScript API](docs/developer-guide/js-api.md)
+- [Plugin development](docs/developer-guide/plugin.md)
+- [Shareable configuration development](docs/developer-guide/shareable-configuration.md)
 
 ## Support
-- [Resources](docs/05-support/resources.md)
-- [Frequently Asked Questions](docs/05-support/FAQ.md)
-- [Troubleshooting](docs/05-support/troubleshooting.md)
-- [Node version requirement](docs/05-support/node-version.md)
-- [Node Support Policy](docs/05-support/node-support-policy.md)
+- [Resources](docs/support/resources.md)
+- [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)
diff --git a/docs/01-usage/getting-started.md b/docs/01-usage/getting-started.md
diff --git a/docs/01-usage/installation.md b/docs/01-usage/installation.md
diff --git a/docs/README.md b/docs/README.md
@@ -1,7 +1,7 @@
 # semantic-release documentation
 
-- [Usage](01-usage/README.md) - **semantic-release** installation and configuration
-- [Extending](02-extending/README.md)- Extending **semantic-release** with plugins and shareable configurations
-- [Recipes](03-recipes/README.md) - Community written recipes for common **semantic-release** use-cases
-- [Developer Guide](04-developer-guide/README.md) - The essentials of writing a **semantic-release** plugin or shareable configurations
-- [Support](05-support/README.md) - FAQ and troubleshooting
+- [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
+- [Support](support/README.md) - FAQ and troubleshooting
diff --git a/docs/04-developer-guide/README.md → docs/developer-guide/README.md b/docs/04-developer-guide/README.md → docs/developer-guide/README.md