diff --git a/website/README.md b/website/README.md index 4b9615b22..128f0155b 100644 --- a/website/README.md +++ b/website/README.md @@ -1,6 +1,7 @@ This website was created with [Docusaurus v2](https://v2.docusaurus.io/). In order to start working with Docusaurus, please read the [Getting Started guide](https://docusaurus.io/docs/configuration) and browse through the following folders and files: + - `website` - contains the Node/React code to build the website - `website/docusaurus.config.js` - contains the Docusaurus configuration; you'll need to edit this file. - `website/static` - contains images, PDF and other static assets used in the website; if you add a `file.pdf` in this folder, it will be served as `https:///file.pdf`. @@ -9,16 +10,18 @@ In order to start working with Docusaurus, please read the [Getting Started guid ## Local run Running Docusaurus locally is very simple, just follow these steps: + - Make sure `node` version is 14 or higher, using `node -v` ; you can use [nvm](https://github.com/nvm-sh/nvm) to install different node versions in your system. - `cd website ; npm install ; npm run start` -The command should open your browser and point to `http://localhost:3000`. +The command should open your browser and point to `http://localhost:8080`. ## Deployment [Netlify] (https://www.netlify.com/) is the default way to serve FINOS websites publicly. Find docs [here] (https://docs.netlify.com/configure-builds/get-started/). You can configure Netlify using your own GitHub account, pointing to a personal repository (or fork); when adding a new site, please use the following configuration: + - Woeking directory: `website` - Build command: `yarn build` - Build directory: `website/build` diff --git a/website/docs/installation.mdx b/website/docs/installation.mdx index 4d807dec5..cb4d4c25f 100644 --- a/website/docs/installation.mdx +++ b/website/docs/installation.mdx @@ -22,7 +22,7 @@ npm install -g @finos/git-proxy-cli To install a specific version of Git Proxy, append the version to the end of the install command: ```bash -npm install -g @finos/git-proxy@1.2.1 +npm install -g @finos/git-proxy@latest ``` To install a specific version of the Git Proxy CLI, append the version to the end of the install command: diff --git a/website/docs/quickstart/approve.mdx b/website/docs/quickstart/approve.mdx index f14841502..ddb73d654 100644 --- a/website/docs/quickstart/approve.mdx +++ b/website/docs/quickstart/approve.mdx @@ -145,16 +145,16 @@ Logout: OK - [x] Proxy and REST API are running ([default behaviour](https://github.com/finos/git-proxy/blob/main/index.js)) - [x] Proxy and REST API are running on `localhost:8000` and `localhost:8080`, respectively -- [x] UI is running on `localhost:3000` +- [x] UI is running on `localhost:8080` ### Instructions #### 1. Login as administrator -[Login](http://localhost:3000/login) to the dashboard. As the UI is running on port `3000`, the URL is: +[Login](http://localhost:8080/login) to the dashboard. As the UI is running on port `3000`, the URL is: ```bash -http://localhost:3000/login +http://localhost:8080/login ``` Fill in the form using the following credentials: diff --git a/website/docs/usage.mdx b/website/docs/usage.mdx index d222bc177..24bbc55d7 100644 --- a/website/docs/usage.mdx +++ b/website/docs/usage.mdx @@ -2,6 +2,7 @@ title: Usage description: How to run Git Proxy in your environment --- + ### Run from global install Once you have followed the [installation](installation) steps, run: @@ -10,7 +11,8 @@ Once you have followed the [installation](installation) steps, run: git-proxy ``` -To run Git Proxy using the CLI +To run Git Proxy using the CLI: + ```bash git-proxy-cli ``` diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 12e82c066..82069bff3 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -2,6 +2,8 @@ const projectName = 'Git Proxy'; +const { version } = require('../package.json'); + module.exports = { title: `${projectName}`, tagline: `Deploy custom push protections and policies on top of Git`, @@ -11,7 +13,7 @@ module.exports = { projectName: `${projectName}`, organizationName: 'FINOS', customFields: { - version: '1.2.1', + version, }, scripts: ['https://buttons.github.io/buttons.js'], stylesheets: ['https://fonts.googleapis.com/css?family=Overpass:400,400i,700'],