Skip to content

docs: link and lint fixes #411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

__Published at: [docs.mojaloop.io](https://docs.mojaloop.io)__


## Building and testing locally

```bash
Expand All @@ -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

Expand All @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion contributing-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/community/contributing/contributors-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
14 changes: 7 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down