mirror of
https://github.com/verdaccio/verdaccio.git
synced 2024-12-30 22:34:10 -05:00
docs: update documentation and frontend page
This commit is contained in:
Juan Picado @jotadeveloper
parent
83ef0b2305
commit
6076a5931f
9 changed files with 59 additions and 49 deletions
|
|
@ -5,7 +5,7 @@ title: "Build the source code"
|
|||
|
||||
Verdaccio relies on `yarn` instead `npm` to download depenedencies.
|
||||
|
||||
*Note: the current build only will build with `➜ yarn --version 0.28.4` or minor. It's not compatible with `yarn 1.x`*
|
||||
*Note: the current build only will build with `➜ yarn` latest.*
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
|
|
|
|||
|
|
@ -100,7 +100,7 @@ publish:
|
|||
allow_offline: false
|
||||
```
|
||||
|
||||
Since: *v2.3.6* due [#223](https://github.com/verdaccio/verdaccio/pull/223)
|
||||
<small>Since: *v2.3.6* due [#223](https://github.com/verdaccio/verdaccio/pull/223)</small>
|
||||
|
||||
### URL Prefix
|
||||
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ We have a frontend website [http://www.verdaccio.org/](http://www.verdaccio.org/
|
|||
|
||||
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 **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 **Cheff** and we need help in those fields, feel free to see all repositories.
|
||||
|
||||
## I'm ready to contribute
|
||||
|
||||
|
|
|
|||
|
|
@ -8,8 +8,10 @@ Verdaccio is a multiplatform web application, to install you need at least some
|
|||
|
||||
#### Prerequisites
|
||||
|
||||
* Node higher than (2.x **4.6.1**) | (3.x **6.12.0)
|
||||
* npm or yarn
|
||||
1. Node higher than
|
||||
- For version *2.x* we support from **4.6.1**
|
||||
- For version *3.x* we support as minimum **6.12.0**
|
||||
2. npm *>=3.x* or yarn
|
||||
|
||||
## Installing the CLI
|
||||
|
||||
|
|
@ -19,13 +21,11 @@ Using `npm`
|
|||
|
||||
```bash
|
||||
npm install -g verdaccio
|
||||
|
||||
```
|
||||
or using `yarn`
|
||||
|
||||
```bash
|
||||
yarn global add verdaccio
|
||||
|
||||
```
|
||||
|
||||
> Warning: Verdaccio current is not support PM2's cluster mode, run it with cluster mode may cause unknown behavior
|
||||
|
|
@ -36,6 +36,8 @@ Once has been installed you only need to execute the CLI command.
|
|||
|
||||
```bash
|
||||
$> verdaccio
|
||||
warn --- config file - /home/.config/verdaccio/config.yaml
|
||||
warn --- http address - http://localhost:5555/ - verdaccio/3.0.0
|
||||
```
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -12,9 +12,8 @@ All tests are split in three folders:
|
|||
|
||||
Unit and functional tests are executed automatically by running `npm test` from the project's root directory. Integration tests are supposed to be executed manually from time to time.
|
||||
|
||||
We use `mocha` for all test.
|
||||
We use `jest` for all test.
|
||||
|
||||
⚠️⚠️ **Functional test** do not work on Windows, but if you are willing to **fix** it we refer you to [#9](https://github.com/verdaccio/verdaccio/issues/9) ⚠️⚠️
|
||||
|
||||
## The npm Script
|
||||
|
||||
|
|
|
|||
|
|
@ -30,25 +30,25 @@ class Footer extends React.Component {
|
|||
this.props.language +
|
||||
'/installation.html'
|
||||
}>
|
||||
Getting Started (or other categories)
|
||||
Getting Started
|
||||
</a>
|
||||
<a
|
||||
href={
|
||||
this.props.config.baseUrl +
|
||||
'docs/' +
|
||||
this.props.language +
|
||||
'/doc2.html'
|
||||
'/docker.html'
|
||||
}>
|
||||
Guides (or other categories)
|
||||
Docker
|
||||
</a>
|
||||
<a
|
||||
href={
|
||||
this.props.config.baseUrl +
|
||||
'docs/' +
|
||||
this.props.language +
|
||||
'/doc3.html'
|
||||
'/configuration.html'
|
||||
}>
|
||||
API Reference (or other categories)
|
||||
Configuration
|
||||
</a>
|
||||
</div>
|
||||
<div>
|
||||
|
|
@ -60,11 +60,11 @@ class Footer extends React.Component {
|
|||
User Showcase
|
||||
</a>
|
||||
<a
|
||||
href="http://stackoverflow.com/questions/tagged/"
|
||||
href="https://stackoverflow.com/search?q=verdaccio"
|
||||
target="_blank">
|
||||
Stack Overflow
|
||||
</a>
|
||||
<a href="https://discordapp.com/">Project Chat</a>
|
||||
<a href="https://gitter.im/verdaccio">Project Chat</a>
|
||||
<a href="https://twitter.com/verdaccio_npm" target="_blank">
|
||||
Twitter
|
||||
</a>
|
||||
|
|
|
|||
|
|
@ -32,7 +32,6 @@
|
|||
"webui": "Web User Interface",
|
||||
"windows": "Installing As a Windows Service",
|
||||
"Docs": "Docs",
|
||||
"API": "API",
|
||||
"Help": "Help",
|
||||
"Blog": "Blog",
|
||||
"Introduction": "Introduction",
|
||||
|
|
|
|||
|
|
@ -36,9 +36,6 @@ class HomeSplash extends React.Component {
|
|||
<div className="homeContainer">
|
||||
<div className="homeSplashFade">
|
||||
<div className="wrapper homeWrapper">
|
||||
<div className="projectLogo">
|
||||
<img src={siteConfig.baseUrl + 'img/verdaccio-tiny@3x.png'} />
|
||||
</div>
|
||||
<div className="inner">
|
||||
<h2 className="projectTitle">
|
||||
<img title={siteConfig.title} src={siteConfig.baseUrl + 'img/verdaccio@2x.png'} />
|
||||
|
|
@ -54,7 +51,7 @@ class HomeSplash extends React.Component {
|
|||
siteConfig.baseUrl +
|
||||
'docs/' +
|
||||
this.props.language +
|
||||
'/doc1.html'
|
||||
'/installation.html'
|
||||
}>
|
||||
Documentation
|
||||
</Button>
|
||||
|
|
@ -63,7 +60,7 @@ class HomeSplash extends React.Component {
|
|||
siteConfig.baseUrl +
|
||||
'docs/' +
|
||||
this.props.language +
|
||||
'/contribute.html'
|
||||
'/contributing.html'
|
||||
}>
|
||||
Contribute
|
||||
</Button>
|
||||
|
|
@ -102,17 +99,19 @@ class Index extends React.Component {
|
|||
align="center"
|
||||
contents={[
|
||||
{
|
||||
content: 'This is the content of my feature',
|
||||
image: siteConfig.baseUrl + 'img/npm.svg',
|
||||
imageAlign: 'top',
|
||||
title: 'Feature One',
|
||||
content: '```bash\n' +
|
||||
'$> npm install --global verdaccio \n' +
|
||||
'$> yarn global add verdaccio\n' +
|
||||
'```',
|
||||
title: 'Easy to Install',
|
||||
},
|
||||
{
|
||||
content: 'The content of my second feature',
|
||||
image: siteConfig.baseUrl + 'img/yarn.svg',
|
||||
imageAlign: 'top',
|
||||
title: 'Feature Two',
|
||||
},
|
||||
content: '```bash\n' +
|
||||
'$> npm set registry http://localhost:4873 \n' +
|
||||
'$> npm adduser --registry http://localhost:4873\n' +
|
||||
'```',
|
||||
title: 'Easy to Set Up',
|
||||
}
|
||||
]}
|
||||
layout="fourColumn"
|
||||
/>
|
||||
|
|
@ -121,18 +120,28 @@ class Index extends React.Component {
|
|||
<div
|
||||
className="productShowcaseSection paddingBottom"
|
||||
style={{textAlign: 'center'}}>
|
||||
<h2>Feature Callout</h2>
|
||||
<MarkdownBlock>These are features of this project</MarkdownBlock>
|
||||
<h2>Easy to Use</h2>
|
||||
<MarkdownBlock>
|
||||
```bash

|
||||
$> verdaccio 

|
||||
warn --- config file - /home/.config/verdaccio/config.yaml 

|
||||
warn --- http address - http://localhost:4873/ - verdaccio/3.0.0

|
||||
```
|
||||
</MarkdownBlock>
|
||||
<h2>
|
||||
That’s it ! Enjoy your private package manager.
|
||||
</h2>
|
||||
</div>
|
||||
|
||||
<Container padding={['bottom', 'top']} background="light">
|
||||
<GridBlock
|
||||
contents={[
|
||||
{
|
||||
content: 'Talk about learning how to use this',
|
||||
content: '**npm** and **yarn** are part of any development workflow,' +
|
||||
' we try to catch up with the latest updates.',
|
||||
image: siteConfig.baseUrl + 'img/verdaccio-tiny@3x.png',
|
||||
imageAlign: 'right',
|
||||
title: 'Learn How',
|
||||
title: 'The most popular npm clients are supported',
|
||||
},
|
||||
]}
|
||||
/>
|
||||
|
|
@ -142,10 +151,17 @@ class Index extends React.Component {
|
|||
<GridBlock
|
||||
contents={[
|
||||
{
|
||||
content: 'Talk about trying this out',
|
||||
content: 'We have an official **Docker** image ready to use 
\n' +
|
||||
'```bash\n' +
|
||||
'docker pull verdaccio/verdaccio
\n' +
|
||||
'```' +
|
||||
'\n and **Kubernetes Helm** support for easy deployment \n '+
|
||||
'```bash\n' +
|
||||
'helm install --name npm stable/verdaccio\n' +
|
||||
'```\n',
|
||||
image: siteConfig.baseUrl + 'img/verdaccio-tiny@3x.png',
|
||||
imageAlign: 'left',
|
||||
title: 'Try it Out',
|
||||
title: 'Making the DevOps work easy',
|
||||
},
|
||||
]}
|
||||
/>
|
||||
|
|
@ -156,10 +172,11 @@ class Index extends React.Component {
|
|||
contents={[
|
||||
{
|
||||
content:
|
||||
'This is another description of how this project is useful',
|
||||
'Verdaccio is plugin based, authentication, middleware and storage support. ' +
|
||||
'Just pick one or create your custom one.',
|
||||
image: siteConfig.baseUrl + 'img/verdaccio-tiny@3x.png',
|
||||
imageAlign: 'right',
|
||||
title: 'Description',
|
||||
title: 'Plugin Support',
|
||||
},
|
||||
]}
|
||||
/>
|
||||
|
|
|
|||
|
|
@ -6,24 +6,17 @@
|
|||
*/
|
||||
|
||||
/* List of projects/orgs using your project for the users page */
|
||||
const users = [
|
||||
{
|
||||
caption: 'User1',
|
||||
image: '/img/docusaurus.svg',
|
||||
infoLink: 'https://www.facebook.com',
|
||||
pinned: true,
|
||||
},
|
||||
];
|
||||
const users = [];
|
||||
|
||||
const siteConfig = {
|
||||
title: 'Verdaccio' /* title for your website */,
|
||||
tagline: 'A lightweight private npm proxy registry',
|
||||
url: 'http://www.verdaccio.org' /* your website url */,
|
||||
organizationName: 'verdaccio',
|
||||
baseUrl: '/' /* base url for your project */,
|
||||
projectName: 'verdaccio',
|
||||
headerLinks: [
|
||||
{doc: 'installation', label: 'Docs'},
|
||||
{doc: 'configuration', label: 'API'},
|
||||
{page: 'help', label: 'Help'},
|
||||
{blog: true, label: 'Blog'},
|
||||
],
|
||||
|
|
@ -41,7 +34,7 @@ const siteConfig = {
|
|||
copyright:
|
||||
'Copyright © ' +
|
||||
new Date().getFullYear() +
|
||||
' Verdaccio Team',
|
||||
' Verdaccio community',
|
||||
// organizationName: 'deltice', // or set an env variable ORGANIZATION_NAME
|
||||
// projectName: 'test-site', // or set an env variable PROJECT_NAME
|
||||
highlight: {
|
||||
|
|
|
|||
Loading…
Reference in a new issue