From 49b3120ded3b0e4a705a9c804a6d0d709f45cf36 Mon Sep 17 00:00:00 2001 From: Juan Picado Date: Wed, 22 Jun 2022 23:12:10 +0200 Subject: [PATCH] chore: improve docs --- website/docs/e2e.md | 7 +++++-- website/docs/install.md | 18 +++++++++++++----- 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/website/docs/e2e.md b/website/docs/e2e.md index a98853a3b..0e57fc5d9 100644 --- a/website/docs/e2e.md +++ b/website/docs/e2e.md @@ -92,8 +92,11 @@ Via CLI: * [aws-sdk cli v3](https://github.com/aws/aws-sdk-js-v3) *(+1k ⭐️)* * [angular-eslint](https://github.com/angular-eslint/angular-eslint) *(+1k ⭐️)* - - +## Example repositories + +- [e2e-ci-example-gh-actions](https://github.com/juanpicado/e2e-ci-example-gh-actions) +- [verdaccio-end-to-end-tests](https://github.com/juanpicado/verdaccio-end-to-end-tests) +- [verdaccio-fork](https://github.com/juanpicado/verdaccio-fork) diff --git a/website/docs/install.md b/website/docs/install.md index 59a30ad04..ace86bce3 100644 --- a/website/docs/install.md +++ b/website/docs/install.md @@ -3,7 +3,7 @@ id: installation title: "Installation" --- -Verdaccio is a multiplatform web application. To install it, you need a few basic prerequisites. +Verdaccio is a Node.js private and proxy registry. To install it, you need a few basic prerequisites. ## Prerequisites {#prerequisites} @@ -23,9 +23,7 @@ Are you still using **Verdaccio 4**?. Check the [migration guide](https://verdac Learn the basics before getting started, how to install, where is the location of the configuration file and more. -[![logo](https://cdn.verdaccio.dev/website/watch-us.png)](https://www.youtube.com/channel/UC5i20v6o7lSjXzAHOvatt0w) - - + ## Installing the CLI {#installing-the-cli} @@ -93,6 +91,8 @@ Or a `publishConfig` in your `package.json` } ``` +For alternative configurations, please read the [Using a privare registry](cli-registry.md) section. + ## Create Your Own Private NPM Package Tutorial {#create-your-own-private-npm-package-tutorial} If you'd like a broader explanation, don't miss the tutorial created by [thedevlife](https://mybiolink.co/thedevlife) on how to Create Your Own Private NPM Package using Verdaccio. @@ -105,7 +105,15 @@ If you'd like a broader explanation, don't miss the tutorial created by [thedevl docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio ``` -`Verdaccio` has an official docker image you can use, and in most cases, the default configuration is good enough. For more information about how to install the official image, [read the docker section](docker.md). +`Verdaccio` has an official docker image you can use, and in most cases, the default configuration is good enough. For more information about how to install the official image, [read the docker section](docker.md), furthermore you can learn more about combining Docker images in our [docker-examples](https://github.com/verdaccio/verdaccio/tree/master/docker-examples) repository. + +## Helm Chart {#helm-chart} + +```bash +$ helm repo add verdaccio https://charts.verdaccio.org +$ helm repo update +$ helm install verdaccio/verdaccio +``` ## Cloudron {#cloudron}