This repo is used to make changes to the documentation hosted on https://detectionlab.network
Most page content is located in the content/
directory. Please open a pull request for each requested change.
Updating documentation is a great way to familiarize yourself with creating pull requests if you've never done it before! Here's some steps to get you started:
- Create a fork of this repo by clicking the "fork" button in the upper right
- You'll now have a fork located at
https://github.com/<your-github-username>/dl-docs/
- Visit that page and click the green "Code" button and copy the HTTPS link that is displayed to you
- From a terminal, run
git clone <the link you just copied>
- Make changes to the .md files inside of the
content/
directory - Once you're done, commit those changes by running
git commit -a
- Checkout a branch with a brief name explaining the change
git checkout -b fix_outdated_splunk_index
- Run
git push
- Visit https://github.com/clong/dl-docs and a button should now be present to let you open a pull request!