empayre/fleet
14
0
Fork 0
mirror of https://github.com/empayre/fleet.git synced 2024-11-06 17:05:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Delete CONTRIBUTING.md (#8340)

Browse Source
This commit is contained in:
Chris McGillicuddy 2022-10-19 10:20:49 -05:00 committed by GitHub
parent 7edce8b6ef
commit 2f3df85c95
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 0 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/Contributing/CONTRIBUTING.md
View File

@ -1,30 +0,0 @@
# Contributing
## Filing issues
### Report a security vulnerability
Sensitive security-related issues should be reported to
[fleetdm.com/contact](https://fleetdm.com/contact) before a public issue is made.
## Contributing to documentation
Fleet currently uses [fleetdm.com/docs](https://fleetdm.com/docs) as the central location for documentation.
### Markdown links
Due to the structure of the Fleet documentation and GitHub's unique markdown files, there are several practices we'd like to call out if your documentation changes include links to other locations within the Fleet docs.
#### Relative links
When including a link to a different file in the Fleet documentation, please use relative links when possible.
For example, let's say you're working on changes in the Contribution docs and you'd like to add a link to the REST API docs. The relative link would look something like `../Using-Fleet/REST-API.md`.
#### Special characters in anchor links
There are certain characters GitHub doesn't support in the use of anchor links in markdown files. The general rule we've found is to only use a-z or A-Z characters in anchor links. All other characters should be removed.
For example, consider the section title *How do I connect to the Mailhog simulated server?*. The valid GitHub anchor link for this section is #how-do-i-connect-to-the-mailhog-simulated-server. Notice the *?* character is removed.
<meta name="pageOrderInSection" value="1000">