Skip to content

Commit

Permalink
Fix Markdownlint warnings
Browse files Browse the repository at this point in the history
Fix a number of Markdownlint warnings.
  • Loading branch information
martincostello committed Mar 4, 2024
1 parent 500ab3d commit ef5816b
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 24 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Great! There are plenty of ways you can help!

If you find a bug, have a feature request or even want to contribute an enhancement or fix, please follow the below guidelines so that we can help you out and/or get your code merged quickly.

## If you find what looks like a bug:
## If you find what looks like a bug

* Check the [GitHub issue tracker](https://github.com/justeattakeaway/JustSaying/issues/ "JustSaying issues") to see if anyone else has reported the same issue.
* Make sure you are using the latest version of JustSaying
* If you are still having problems then [create an issue](https://github.com/justeattakeaway/JustSaying/issues/new/choose) with enough information so that it can be reproduced and diagnosed

## If you want to contribute an enhancement or a fix:
## If you want to contribute an enhancement or a fix

1. Discuss any major enhancement with the project maintainers by creating either an [issue](https://github.com/justeattakeaway/JustSaying/issues/new/choose) or a [discussion](https://github.com/justeattakeaway/JustSaying/discussions).
1. Work on your changes and add any relevant unit and/or functional tests.
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# 5.0.0

See https://github.com/justeattakeaway/JustSaying/releases/tag/v5.0.0.
See [here](https://github.com/justeattakeaway/JustSaying/releases/tag/v5.0.0).
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ A helpful library for publishing and consuming events / messages over SNS (SNS /

## Documentation

Docs can be found [here](https://justeat.gitbook.io/justsaying/).
Documentation can be found [here](https://justeat.gitbook.io/justsaying/).

If you want to contribute to the docs, they are in the [docs branch](https://github.com/justeattakeaway/JustSaying/tree/docs) - PRs should be issued against this branch.
If you want to contribute to the documentation, they are in the [docs branch](https://github.com/justeattakeaway/JustSaying/tree/docs) - PRs should be issued against this branch.

## Contributing

Please read the [contributing guide](./.github/CONTRIBUTING.md "Contributing to JustSaying").

### The End

..._Happy Messaging!..._
_Happy Messaging!_
2 changes: 2 additions & 0 deletions Releases.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Releases

## About Versioning

JustSaying adopts [SemVer 2.0](https://semver.org/spec/v2.0.0.html), and uses [MinVer](https://github.com/adamralph/minver) to achieve this. [See here](https://github.com/adamralph/minver#how-it-works) for more information on how it works.
Expand Down
37 changes: 19 additions & 18 deletions docs/Documentation_generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,19 @@
## Integration with Visual Studio Code

- Install the plugin
- [PlantUML plugin for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml)

- Add the below to your user settings in Visual Studio Code

```json
"plantuml.exportFormat": "png",
"plantuml.render": "PlantUMLServer",
"plantuml.server": "http://localhost:8080",
"plantuml.diagramsRoot": "docs",
"plantuml.exportOutDir": "docs",
"plantuml.exportSubFolder": false
```
- [PlantUML plugin for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml)
- Add the below to your user settings in Visual Studio Code

```json
{
"plantuml.exportFormat": "png",
"plantuml.render": "PlantUMLServer",
"plantuml.server": "http://localhost:8080",
"plantuml.diagramsRoot": "docs",
"plantuml.exportOutDir": "docs",
"plantuml.exportSubFolder": false
}
```

- Run a [PlantUML Server](https://github.com/plantuml/plantuml-server) locally to translate from `.puml` files into `.png` images

Expand All @@ -27,14 +28,14 @@
```

- To live preview an image while editing
- Open a `.puml`
- Press F1
- Select `PlantUML: Preview Current Diagram`
- Open a `.puml`
- Press F1
- Select `PlantUML: Preview Current Diagram`

- To regenerate all images
- Press F1
- Select `PlantUML: Export workspace diagrams`
- All images in `/docs` will be regenerated
- Press F1
- Select `PlantUML: Export workspace diagrams`
- All images in `/docs` will be regenerated

## Further reading

Expand Down

0 comments on commit ef5816b

Please sign in to comment.