From a8f8bffa3747b78bbac1c30f3faaf011750b592f Mon Sep 17 00:00:00 2001 From: Emmanuel Sciara Date: Wed, 31 Jul 2019 00:06:19 +0200 Subject: [PATCH] docs(recipes): cleaned doc and navigation Corrected inconsistancies between the sidebar and the actual pages. Remove non existing pages. Clarified status of "Package managers and languages" to "to be completed". --- .gitignore | 2 ++ SUMMARY.md | 7 +++---- docs/recipes/README.md | 10 +--------- docs/recipes/ci-configurations.md | 4 ++++ docs/recipes/git-hosted-services.md | 12 ++++++++++++ docs/recipes/package-managers-and-languages.md | 2 ++ 6 files changed, 24 insertions(+), 13 deletions(-) create mode 100644 docs/recipes/ci-configurations.md create mode 100644 docs/recipes/git-hosted-services.md create mode 100644 docs/recipes/package-managers-and-languages.md diff --git a/.gitignore b/.gitignore index 058ab690..45ad3560 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +# Jetbrains IDEs +.idea # Created by https://www.gitignore.io/api/macos,windows,linux,node diff --git a/SUMMARY.md b/SUMMARY.md index a9cfa57d..e7946823 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -12,14 +12,13 @@ - [Shareable configuration](docs/extending/shareable-configurations-list.md) ## Recipes -- [CI configurations](docs/recipes/README.md) +- [CI configurations](docs/recipes/ci-configurations.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) -- [Git hosted services](docs/recipes/README.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/README.md) +- [Package managers and languages](docs/recipes/package-managers-and-languages.md) ## Developer guide - [JavaScript API](docs/developer-guide/js-api.md) diff --git a/docs/recipes/README.md b/docs/recipes/README.md index d839f0d5..c3b0d84b 100644 --- a/docs/recipes/README.md +++ b/docs/recipes/README.md @@ -1,11 +1,3 @@ -# Recipes - -## CI configurations -- [CircleCI 2.0 workflows](circleci-workflows.md) -- [Travis CI](travis.md) -- [GitLab CI](gitlab-ci.md) - -## Git hosted services +# Git hosted services - [Git authentication with SSH keys](git-auth-ssh-keys.md) -## Package managers and languages diff --git a/docs/recipes/ci-configurations.md b/docs/recipes/ci-configurations.md new file mode 100644 index 00000000..5126288f --- /dev/null +++ b/docs/recipes/ci-configurations.md @@ -0,0 +1,4 @@ +# CI configurations +- [CircleCI 2.0 workflows](circleci-workflows.md) +- [Travis CI](travis.md) +- [GitLab CI](gitlab-ci.md) diff --git a/docs/recipes/git-hosted-services.md b/docs/recipes/git-hosted-services.md new file mode 100644 index 00000000..fd2ad886 --- /dev/null +++ b/docs/recipes/git-hosted-services.md @@ -0,0 +1,12 @@ +# Recipes + +## CI configurations +- [CircleCI 2.0 workflows](circleci-workflows.md) +- [Travis CI](travis.md) +- [GitLab CI](gitlab-ci.md) + +## Git hosted services +- [Git authentication with SSH keys](git-auth-ssh-keys.md) + +## Package managers and languages (to be completed) + diff --git a/docs/recipes/package-managers-and-languages.md b/docs/recipes/package-managers-and-languages.md new file mode 100644 index 00000000..6c0669e8 --- /dev/null +++ b/docs/recipes/package-managers-and-languages.md @@ -0,0 +1,2 @@ +# Package managers and languages (to be completed) +