Skip to content

Commit

Permalink
making linter happy (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
Zabuzard authored Dec 9, 2023
1 parent ea45f99 commit defe519
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 14 deletions.
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
"VISIDENT",
"Vought",
"WRCS",
"yada",
"zeroize"
]
}
38 changes: 24 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,38 +15,43 @@ helping you finalize your pull requests.

## Legal yada yada

The manual is published under the [CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/deed.en).
The manual is published under the
[CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/).
Please make sure you understand its terms.

Additionally, by submitting a PR and contributing to the project, you transfer the rights you
hold to your own contribution to Heatblur Simulations. That is, Heatblur Simulations is free to use
the content you created under the terms of the above license.
Additionally, by submitting a PR and contributing to the project, you transfer
the rights you hold to your own contribution to Heatblur Simulations. That is,
Heatblur Simulations is free to use the content you created under the terms of
the above license.

## Ground Rules

<!-- markdown-link-check-disable -->
- Create [issues](https://github.com/Heatblur-Simulations/f-4e-manual/issues)
for any major changes and enhancements that you wish to make, as well as for
reporting any sort of bugs. For more light-hearted talks, you can use
[discussions](https://github.com/Heatblur-Simulations/f-4e-manual/discussions).
Discuss things transparently and get community feedback.
- Be welcoming to newcomers and encourage diverse new contributors from all
backgrounds.
<!-- markdown-link-check-enable -->

## Your First Contribution

Unsure where to begin contributing to the manual? You can start by looking
through these labels!

- [good first issue](https://github.com/Heatblur-Simulations/f-4e-manual/issues/?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) -
<!-- markdown-link-check-disable-next-line -->
- [good first issue](https://github.com/Heatblur-Simulations/f-4e-manual/issues/?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22),
issues which should only require a few minor changes.

Let us know that you intend to work on the issue by commenting on it, and we
will assign it to you.

Working on your first Pull Request? You can check these resources:

- http://makeapullrequest.com/
- http://www.firsttimersonly.com/
- <http://makeapullrequest.com/>
- <http://www.firsttimersonly.com/>

At this point, you're ready to make your changes! Feel free to ask for help;
everyone is a beginner at first! 🎉
Expand All @@ -55,9 +60,11 @@ everyone is a beginner at first! 🎉

### Create an issue

<!-- markdown-link-check-disable -->
Before creating a new issue, make sure to
[search](https://github.com/Heatblur-Simulations/f-4e-manual/issues?q=is%3Aissue) for
existing issues first.
[search](https://github.com/Heatblur-Simulations/f-4e-manual/issues?q=is%3Aissue)
for existing issues first.
<!-- markdown-link-check-enable -->

If the issue already exists, comment on it saying that you intend to work on it,
and we will assign it to you!
Expand Down Expand Up @@ -97,10 +104,13 @@ consider checking these resources:

### Create a pull request

<!-- markdown-link-check-disable -->
When you are done, you will create a
[pull request](https://github.com/Heatblur-Simulations/f-4e-manual/pulls) to request
feedback from the rest of the community. At this point, your contribution will be
automatically tested and then checked by a member of the Heatblur Team.
[pull request](https://github.com/Heatblur-Simulations/f-4e-manual/pulls) to
request feedback from the rest of the community. At this point, your
contribution will be automatically tested and then checked by a member of the
Heatblur Team.
<!-- markdown-link-check-enable -->

Each pull request should be clear, concise, and informative. Please consider
checking these resources:
Expand All @@ -116,8 +126,8 @@ or fix more than one thing, please submit another pull request.
After you created a PR, automated checks will be run. PR cannot be merged
without all tests passing, so make sure to fix all the issues that are found.

Your PR will be reviewed, and after being accepted by at least one member of
the Heatblur Team, it will get merged to the `master` branch! 🎉
Your PR will be reviewed, and after being accepted by at least one member of the
Heatblur Team, it will get merged to the `master` branch! 🎉

From there on, it will lead to an automatic re-deployment of the manual and your
changes being live on the real website!
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# F-4E Manual

<!-- markdown-link-check-disable-next-line -->
[![license](https://img.shields.io/badge/license-CC_BY--NC--ND_4.0-blue)](https://github.com/Heatblur-Simulations/f-4e-manual/blob/master/LICENSE)

![Spook - My Other Ride Is Your Mom](https://i.imgur.com/KBOIocl.png)
Expand All @@ -24,19 +25,23 @@ You can also simply press `.` (dot) while on GitHub and it will open an instance
of Visual Studio Code right in your browser, allowing you to contribute directly
and conveniently.

<!-- markdown-link-check-disable -->
Please read
[CONTRIBUTING.md](https://github.com/Heatblur-Simulations/f-4e-manual/blob/master/CONTRIBUTING.md)
before your first contribution.
<!-- markdown-link-check-enable -->

### Building locally

To build the website locally, you have to install **mdBook**, see
[here](https://rust-lang.github.io/mdBook/guide/installation.html).

<!-- markdown-link-check-disable -->
Then run the command `mdbook build` from this folder; the website can be found
in the folder `book/html`. Use `mdbook serve` to make the contents available in your
browser at [localhost:3000](http://localhost:3000/), it automatically updates
whenever the contents change.
<!-- markdown-link-check-enable -->

To build the PDF locally, use `cargo install mdbook-pdf` first. Then, when running `mdbook build`,
the PDF will be created in `book/pdf`.
Expand Down
2 changes: 2 additions & 0 deletions src/f4e_manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@ This is the manual of the F-4E Phantom II by
[Heatblur Simulations](https://store.heatblur.com/) for
[DCS World](https://www.digitalcombatsimulator.com).

<!-- markdown-link-check-disable -->
A PDF version is available
[here](https://github.com/Heatblur-Simulations/f-4e-manual/releases). The
contents are open-source at
[GitHub](https://github.com/Heatblur-Simulations/f-4e-manual), you are most
welcome to contribute!
<!-- markdown-link-check-enable -->

![f4e_vapor_shot](img/Vapes_06.jpg)

0 comments on commit defe519

Please sign in to comment.