From ce5d80e1ac3256414da4f142281b512e6e725572 Mon Sep 17 00:00:00 2001 From: Miguel de Barros Date: Thu, 30 Mar 2023 18:48:51 +0200 Subject: [PATCH 1/4] docs: fixed deployment guide link from contributors guidelines --- docs/community/contributing/contributors-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/community/contributing/contributors-guide.md b/docs/community/contributing/contributors-guide.md index 25a25b60e..80411e2c7 100644 --- a/docs/community/contributing/contributors-guide.md +++ b/docs/community/contributing/contributors-guide.md @@ -20,7 +20,7 @@ Based on the current phase of the Mojaloop project, we are looking for one of th ## How do I contribute? -* Review the [Mojaloop Deployment](https://docs.mojaloop.io/documentation/deployment-guide/) Guide and the [Onboarding Guide](https://github.com/mojaloop/mojaloop/blob/master/onboarding.md). +* Review the [Mojaloop Deployment](../../technical/deployment-guide/README.md) Guide and the [Onboarding Guide](https://github.com/mojaloop/mojaloop/blob/master/onboarding.md). * Browse through the [Repository Overview](https://docs.mojaloop.io/documentation/repositories/) to understand how the Mojaloop code is managed across multiple Github Repositories. * Get familiar with our [Standards](../standards/guide.md) for contributing to this project. * Go through the [New Contributor Checklist](./new-contributor-checklist.md), and browse through the project board and work on your [good first issue](https://github.com/mojaloop/project/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) From 32c6b91cf11784f6264e9590af7c3d1228b54d07 Mon Sep 17 00:00:00 2001 From: Miguel de Barros Date: Thu, 30 Mar 2023 18:49:29 +0200 Subject: [PATCH 2/4] docs: fixed "Setting up locally" link from contributors guidelines --- contributing-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing-guide.md b/contributing-guide.md index bf806ee32..6c739d397 100644 --- a/contributing-guide.md +++ b/contributing-guide.md @@ -8,7 +8,7 @@ The first step in contributing to the Mojaloop documentation repository is to go ## Setting up locally -Refer to the [README](./README#building-and-testing-locally) for guide on how to setup the documentation site locally. +Refer to the [README](./README.md#building-and-testing-locally) for guide on how to setup the documentation site locally. ## Adding Content From bc947d8591b73431023ca32fa47983a51e5f0102 Mon Sep 17 00:00:00 2001 From: Miguel de Barros Date: Thu, 30 Mar 2023 18:50:34 +0200 Subject: [PATCH 3/4] chore: updated dependencies --- package-lock.json | 14 +++++++------- package.json | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/package-lock.json b/package-lock.json index 7a4c4c348..eadfdc1b3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "got": "^12.6.0", "husky": "^8.0.3", "markdownlint-cli": "^0.33.0", - "npm-check-updates": "^16.8.0", + "npm-check-updates": "^16.9.0", "plantuml-encoder": "^1.4.0", "svgo": "^3.0.2", "vuepress": "^1.9.9", @@ -12693,9 +12693,9 @@ } }, "node_modules/npm-check-updates": { - "version": "16.8.0", - "resolved": "https://registry.npmjs.org/npm-check-updates/-/npm-check-updates-16.8.0.tgz", - "integrity": "sha512-2xpFtUPa2OyswC8kpIpxRqQcP/D0uqaBgfiOQAtvGlnDhmHr3QwR2gWjjWtS6xnNvgyyVly/4edY0Uu24c46ew==", + "version": "16.9.0", + "resolved": "https://registry.npmjs.org/npm-check-updates/-/npm-check-updates-16.9.0.tgz", + "integrity": "sha512-AOAAre4AAPzB5p41E8vbkisx7FypdNCy4mkiF4mMUl6ptOUVkaMGlWVx1eqgmaoraeAnvhyByIGS+4LN7U+XHg==", "dev": true, "dependencies": { "chalk": "^5.2.0", @@ -30936,9 +30936,9 @@ } }, "npm-check-updates": { - "version": "16.8.0", - "resolved": "https://registry.npmjs.org/npm-check-updates/-/npm-check-updates-16.8.0.tgz", - "integrity": "sha512-2xpFtUPa2OyswC8kpIpxRqQcP/D0uqaBgfiOQAtvGlnDhmHr3QwR2gWjjWtS6xnNvgyyVly/4edY0Uu24c46ew==", + "version": "16.9.0", + "resolved": "https://registry.npmjs.org/npm-check-updates/-/npm-check-updates-16.9.0.tgz", + "integrity": "sha512-AOAAre4AAPzB5p41E8vbkisx7FypdNCy4mkiF4mMUl6ptOUVkaMGlWVx1eqgmaoraeAnvhyByIGS+4LN7U+XHg==", "dev": true, "requires": { "chalk": "^5.2.0", diff --git a/package.json b/package.json index 6bbf3e657..257ecb8dd 100644 --- a/package.json +++ b/package.json @@ -28,7 +28,7 @@ "got": "^12.6.0", "husky": "^8.0.3", "markdownlint-cli": "^0.33.0", - "npm-check-updates": "^16.8.0", + "npm-check-updates": "^16.9.0", "plantuml-encoder": "^1.4.0", "svgo": "^3.0.2", "vuepress": "^1.9.9", From 5e9734a48b3735043fb0c30dff6db93a47e1ddf9 Mon Sep 17 00:00:00 2001 From: Miguel de Barros Date: Thu, 30 Mar 2023 18:51:54 +0200 Subject: [PATCH 4/4] docs: fixed lint issues in main readme --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4e6228686..857e1c8ec 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ __Published at: [docs.mojaloop.io](https://docs.mojaloop.io)__ - ## Building and testing locally ```bash @@ -17,8 +16,8 @@ npm run dev ``` ## Building the project -Run `npm run build` to build the project to render the static vuepress site for a deployment. +Run `npm run build` to build the project to render the static vuepress site for a deployment. ## Rebuild all Puml -> svg @@ -41,6 +40,7 @@ This script also runs as a git commit hook, so any changes added to puml sources rendered to svg without you having to do anything! If you want to skip the commit hook, you can always run `git commit -n` + ## Versioning We use `vuepress-plugin-versioning` to help us keep older versions of our docs for posterity. By default, when you browse @@ -62,13 +62,15 @@ We are working to automate this process, but for now, you can make a new version ### Deploying Manually You can also deploy them manually, by running: + ```bash ./scripts/_deploy_preview_s3.sh -``` +``` Note that you need to have the `aws` cli, AWS access, and `aws-mfa` set up on your machine for this to work. ## Contributing to the project + Please refer to the [Contributing Guide](./contributing-guide.md) for details on how to contribute to Mojaloop Docs 2.0. ## License