Skip to content

Commit

Permalink
Clean up links in the docs (openclarity#548)
Browse files Browse the repository at this point in the history
* Fix contributing link in PR template

* Remove unnessecary slash from the links
  • Loading branch information
arpad-csepi authored Aug 16, 2023
1 parent f97cc0c commit 3d2bffa
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ change, which may lead to your PR taking much longer to review, or result in it

## Checklist

- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md)
- [ ] I have read the [contributing guidelines](CONTRIBUTING.md)
- [ ] Existing issues have been referenced (where applicable)
- [ ] I have verified this change is not present in other open pull requests
- [ ] Functionality is documented
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ addressing your issue, assessing changes, and helping you finalize your pull req
we endeavor to review incoming issues and pull requests within 10 days, and will close any lingering issues or pull
requests after 60 days of inactivity.

Please note that all of your interactions in the project are subject to our [Code of Conduct](/CODE_OF_CONDUCT.md). This
Please note that all of your interactions in the project are subject to our [Code of Conduct](CODE_OF_CONDUCT.md). This
includes creation of issues or pull requests, commenting on issues or pull requests, and extends to all interactions in
any real-time space e.g., Slack, Discord, etc.

Expand All @@ -27,7 +27,7 @@ any real-time space e.g., Slack, Discord, etc.

## Troubleshooting and Debugging

Please see the troubleshooting and debugging guide [here](/docs/troubleshooting.md).
Please see the troubleshooting and debugging guide [here](docs/troubleshooting.md).

## Reporting Issues

Expand All @@ -38,7 +38,7 @@ When creating a new issue, please be sure to include a **title and clear descrip
possible, and, if possible, a test case.

**If you discover a security bug, please do not report it through GitHub. Instead, please see security procedures in
[SECURITY.md](/SECURITY.md).**
[SECURITY.md](SECURITY.md).**

## Development

Expand Down Expand Up @@ -98,7 +98,7 @@ api` to regenerate the model, client and server code.
### Testing End to End

For details on how to test VMClarity end to end please see the End to End
testing guide [here](/docs/test_e2e.md).
testing guide [here](docs/test_e2e.md).

## Sending Pull Requests

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ For a detailed installation guide, please see [AWS](installation/aws/README.md).
```
2. Access VMClarity UI in the browser: http://localhost:8080/
3. Access the [API](/api/openapi.yaml) via http://localhost:8080/api
3. Access the [API](api/openapi.yaml) via http://localhost:8080/api
For a detailed UI tour, please see [tour](TOUR.md).
Expand Down Expand Up @@ -126,13 +126,13 @@ VMClarity project roadmap is available [here](https://github.com/orgs/openclarit
# Contributing
If you are ready to jump in and test, add code, or help with documentation,
please follow the instructions on our [contributing guide](/CONTRIBUTING.md)
please follow the instructions on our [contributing guide](CONTRIBUTING.md)
for details on how to open issues, setup VMClarity for development and test.
# Code of Conduct
You can view our code of conduct [here](/CODE_OF_CONDUCT.md).
You can view our code of conduct [here](CODE_OF_CONDUCT.md).
# License
[Apache License, Version 2.0](/LICENSE)
[Apache License, Version 2.0](LICENSE)
2 changes: 1 addition & 1 deletion docs/test_e2e.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ DOCKER_REGISTRY=<your docker registry> make push-docker

## Performing an end to end test

1. Copy the example [scanConfig.json](/docs/scanConfig.json) into the ubuntu user's home directory
1. Copy the example [scanConfig.json](scanConfig.json) into the ubuntu user's home directory

```
scp scanConfig.json ubuntu@<ip address>:~/scanConfig.json
Expand Down

0 comments on commit 3d2bffa

Please sign in to comment.