Infrastructure/verdaccio
0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2025-03-18 02:22:46 -05:00
Code Issues Activity

Merge pull request #478 from drubin/improve-docs

Browse source 
Improve docs
This commit is contained in:
Juan Picado @jotadeveloper 2018-01-16 00:04:54 +01:00 • committed by GitHub
commit cc2c86856e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.github/pull_request_template.md vendored
View file

@ -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 #???

9
docs/contributing.md
View file

@ -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.
![](https://d3n8a8pro7vhmx.cloudfront.net/uridu/pages/144/attachments/original/1485948891/Crowdin.png?1485948891 | width=100)
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).