Merge pull request #63 from cisagov/release-1.1.0-small

Merge Release-1.1.0-small to Main

.github/ISSUE_TEMPLATE/bug-or-error-report.md

@@ -0,0 +1,59 @@
+---
+name: Bug or Error report
+about: Report issues, mistakes, unsolvable, or unresolved errors to help improve the project
+title: "[BUG] ERROR YYYYY in step X.X"
+labels: bug
+assignees: ''
+
+---
+
+## **BEFORE CREATING THE ISSUE, CHECK THE FOLLOWING GUIDES**: 
+ - [ ] [FAQ](https://github.com/cisagov/LME/blob/main/docs/markdown/reference/faq.md)
+ - [ ] [Troubleshooting](https://github.com/cisagov/LME/blob/main/docs/markdown/reference/troubleshooting.md)
+ - [ ] Search current/closed issues for similar questions, and utilize github/google search to see if an answer exists for the error I'm encountering.  
+
+If the above did not answer your question, proceed with creating an issue below: 
+
+## Describe the bug
+A clear and concise description of what the bug is.
+
+## To Reproduce
+Steps to reproduce the behavior. These should be clear enough that our team can understand your running environment, software/operating system versions, and anything else we might need to debug the issue. 
+
+An example of a usable reproducible list are shown in these issues: [Issue 1](https://github.com/cisagov/LME/issues/15) [Issue 2](https://github.com/cisagov/LME/issues/19). 
+
+To increase the speed and relevance of the reply we suggest you list down debugging steps you have tried, as well as the following information:
+
+### Please complete the following information
+**Desktop:**
+ - OS: [e.g. Windows 10]
+ - Browser: [e.g. Firefox Version 104.0.1]
+ - Software version: [e.g. Sysmon v15.0, Winlogbeat 8.11.1]
+
+**Server:**
+- OS: [e.g. Ubuntu 22.04]
+- Software Versions:
+  - ELK: [e.g. 8.7.1]
+  - Docker: [e.g. 20.10.23, build 7155243]
+- The output of these commands: 
+```
+free -h
+df -h 
+uname -a 
+lsb_release -a
+```
+- Relevant container logs: 
+```
+for name in $(sudo docker ps -a --format '{{.Names}}'); do echo -e "\n\n\n-----------$name----------"; sudo docker logs $name | tail -n 20; done
+```
+Increase the number of lines if your issue is not present, or include a relevant log of the erroring container
+- Output of the relevant /var/log/cron_logs/ file
+
+## Expected behavior
+A clear and concise description of what you expected to happen.
+
+## Screenshots
+If applicable, add screenshots to help explain your problem.
+
+## Additional context
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,39 @@
+
+## 🗣 Description ##
+
+<!-- Describe the "what" of your changes in detail. -->
+
+### 💭 Motivation and context 
+
+<!-- Why is this change required? -->
+<!-- What problem does this change solve? How did you solve it? -->
+<!-- Mention any related issue(s) here using appropriate keywords such -->
+<!-- as "closes" or "resolves" to auto-close them on merge. -->
+
+### 📷 Screenshots (DELETE IF UNAPPLICABLE)
+
+## 🧪 Testing 
+
+<!-- How did you test your changes? How could someone else test this PR? -->
+<!-- Include details of your testing environment, and the tests you ran to -->
+<!-- see how your change affects other areas of the code, etc. -->
+
+## ✅ Pre-approval checklist ##
+
+- [ ] Changes are limited to a single goal **AND** 
+      the title reflects this in a clear human readable format
+- [ ] I have read and agree to LME's [CONTRIBUTING.md](https://github.com/cisagov/LME/CONTRIBUTING.md) document.
+- [ ] The PR adheres to LME's requirements in [RELEASES.md](https://github.com/cisagov/LME/RELEASES.md#steps-to-submit-a-PR)
+- [ ] These code changes follow [cisagov code standards](https://github.com/cisagov/development-guide).
+- [ ] All relevant repo and/or project documentation has been updated to reflect the changes in this PR.
+
+## ✅ Pre-merge Checklist
+
+- [ ] All tests pass
+- [ ] PR has been tested and the documentation for testing is above
+
+## ✅ Post-merge Checklist
+
+- [ ] Squash all commits into one PR level commit 
+- [ ] Delete the branch to keep down number of branches
+

.gitignore

@@ -1,2 +1,17 @@
 *.pdf
 .DS_Store
+/.idea/
+/.vscode/
+/Chapter 4 Files/*.dumped.ndjson
+/Chapter 4 Files/exported/
+
+#created files should be ignored:
+Chapter 3 Files/certs/
+Chapter 3 Files/docker-compose-stack-live.yml
+Chapter 3 Files/logstash.edited.conf
+Chapter 3 Files/logstash_custom.conf
+LME/
+dashboard_update.sh
+files_for_windows.zip
+lme.conf
+lme_update.sh

CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Welcome #
+
+We're so glad you're thinking about contributing to this open-source project! If you're unsure or hesitant to make a recommendation, just ask, submit the issue, or pull request. The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contribution(s), and don't want a wall of rules to stifle innovation.
+
+Before contributing, we encourage you to read our CONTRIBUTING policy (you are here), our LICENSE, and our README, all of which are in this repository.
+
+## Issues 
+
+If you want to report a bug or request a new feature, the most direct method is to [create an issue](https://github.com/cisagov/development-guide/issues) in this repository.  
+We recommend that you first search through existing issues (both open and closed) to check if your particular issue has already been reported.  
+
+If it has then you might want to add a comment to the existing issue.  
+
+If it hasn't then feel free to create a new one. 
+
+Please follow the provided template and fill out all sections. We have a `BUG` and `FEATURE REQUEST` Template
+
+## Pull Requests (PR)
+
+If you choose to submit a pull request, it will be required to pass various sanity checks in our continuous integration (CI) pipeline, before we merge it. Your pull request may fail these checks, and that's OK. If you want you can stop there and wait for us to make the necessary corrections to ensure your code passes the CI checks, you're more than within your rights; however, it helps our team greatly if you fix the issues found by our CI pipeline. 
+
+Below are some loose requirements we'd like all PR's to follow. Our release process is documented in [Releases](releases.md).
+
+### Quality assurance and code reviews
+
+All PRs will be tested, vetted, and reviewed by our team before being merged with the main code base. All should be pull requested into whatever the upcoming release branch is. Find that by searching for the highest SEMVER `release-X.Y.Z` branch or following our release documentation.
+
+### Steps to submit a PR
+	- All PRs should request merges back into LME's *CLOSEST* Major or Minor upcoming release branch `release-X.Y.Z`. This will be viewable in the branch list on Github. You can also refer to our release documentation for guidance.
+  - If the PR corresponds to an issue we are already tracking on LME's public Github [project](https://github.com/orgs/cisagov/projects/68), please comment the PR in the issue, and we will update the issue. 
+  - If the PR does not have an issue, please add a comment at the top of the pull request describing the PR and how it fits into LME's project/code. If the PR follows our other requirements listed here, we'll add it into our public project linked previously.
+  - We'll work with you to mold it to our development goals/process, so your work can be merged into LME and your Github profile gets credit for the contributions. 
+  - Before merging we request that all commits be squashed into one commit. This way your changes to the repository are tracked, but our `git log` history does not rapidly expand. 
+  - Thanks for wanting to submit and develop improvements for LME!!
+
+## Public domain 
+
+This project is in the public domain within the United States, and
+copyright and related rights in the work worldwide are waived through
+the [CC0 1.0 Universal public domain
+dedication](https://creativecommons.org/publicdomain/zero/1.0/).
+
+All contributions to this project will be released under the CC0
+dedication. By submitting a pull request, you are agreeing to comply
+with this waiver of copyright interest.

Chapter 3 Files/.gitignore

@@ -0,0 +1 @@
+*-live.*