From 318c41c64881d8ed7c7359f3d3cad2136d0e533b Mon Sep 17 00:00:00 2001 From: David Rubin <davidrub@gmail.com> Date: Mon, 15 Jan 2018 23:15:42 +0100 Subject: [PATCH 1/2] docs: Fix typos and links * Update chef name * Replace broken link * Fix image (GitHub seemed to have changed their markdown syntax) --- docs/contributing.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 151eff44c..a8bf91259 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -24,7 +24,7 @@ All we have different skills, so, let's see where you might feel comfortable. Node.js is the base of `verdaccio`, we use libraries as `express`, `commander`, `request` or `async`. Verdaccio is basically a Rest API that create a communication with `npm` clients compatible, as `yarn`. -We have a long [list of plugins](https://github.com/verdaccio/verdaccio/blob/master/wiki/plugins.md) ready to be used and improved but at the same time [you might create your own](plugin.md). +We have a long [list of plugins](plugins.md) ready to be used and improved but at the same time [you might create your own](dev-plugins.md). ### I would prefer to work in the User Interface @@ -57,14 +57,13 @@ Our website is based on [Docusaurus](https://docusaurus.io/). We have a widely popular Docker image [https://hub.docker.com/r/verdaccio/verdaccio/](https://hub.docker.com/r/verdaccio/verdaccio/) that need maintenance and pretty likely huge improvements, we need your knowledge for the benefits of all users. -We have support for **Kubernetes**, **Puppet**, **Ansible** and **Cheff** and we need help in those fields, feel free to see all repositories. +We have support for **Kubernetes**, **Puppet**, **Ansible** and **Chef** and we need help in those fields, feel free to see all repositories. ### I can do translations -Verdaccio aims to be multilingual, in order to achieve it we have the awesome support of [Crowdin](https://crowdin.com) that is an amazing platform for translations. - - +Verdaccio aims to be multilingual, in order to achieve it we have the awesome support of [Crowdin](https://crowdin.com) that is an amazing platform for translations. +<img src="https://d3n8a8pro7vhmx.cloudfront.net/uridu/pages/144/attachments/original/1485948891/Crowdin.png" width="100px"/> We have setup a project where you can choose your favourite language, if you do not find your language feel free to request one [creating a ticket](https://github.com/verdaccio/verdaccio/issues/new). From 092767b4cbae029448d35355a3810258f0fc9457 Mon Sep 17 00:00:00 2001 From: David Rubin <davidrub@gmail.com> Date: Mon, 15 Jan 2018 23:20:30 +0100 Subject: [PATCH 2/2] docs: Improve english in pull request template --- .github/pull_request_template.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 07d13dad9..42b17bae5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -3,8 +3,8 @@ https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md#git-commit-gu --> <!-- - If your Pull Request fix an issue don't forget to update the unit test and documentation in /wiki folder - If your Pull Request deliver a new feature, please, provide examples and why such feature should be considered, this information is important to document the Github changelog. Also try to increase documentation and create new unit/functional test. + If your Pull Request fix an issue don't forget to update the unit test and documentation in /docs folder + If your Pull Request delivers a new feature, please, provide examples and why such feature should be considered, this information is important to document the Github changelog. Also, try to increase documentation and create new unit/functional test. --> <!-- Pick only one type, whether none apply, please suggest one, we might be included it by default --> @@ -21,7 +21,7 @@ Our bots should ensure: * The PR passes CI testing --> -<!-- If there is no issue related with this PR just remove the following section --> +<!-- If there is no issue related to this PR just remove the following section --> **Description:** Resolves #???