From 3a96de67c09e6a97aafbc25566c9e33151945b4e Mon Sep 17 00:00:00 2001 From: divious1 Date: Wed, 17 Jun 2020 21:43:18 -0400 Subject: [PATCH] clean up of docs --- README.md | 6 +- docs/CONTRIBUTING.md | 130 --------------------------- docs/contributing/code-of-conduct.md | 73 --------------- 3 files changed, 3 insertions(+), 206 deletions(-) delete mode 100644 docs/CONTRIBUTING.md delete mode 100644 docs/contributing/code-of-conduct.md diff --git a/README.md b/README.md index 64f9750747..b8a21cf74f 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ curl -s https://content.splunkresearch.com | jq } ``` -#### [GitHub Workflow](https://github.com/splunk/security-content/wiki/2.-Installation-and-Usage) +#### [GitHub Workflow](https://github.com/splunk/security-content/wiki/Installation-and-Usage) Create your customized version of Security Content by forking this project and following this guide. # What's in an Analytic Story? @@ -56,7 +56,7 @@ Download and install the latest version of [Splunk Analytic Story Execution] # Writing Content -Before you begin, follow the steps to install **dependencies and pre-commit hooks** under ["Developing"](https://github.com/splunk/security-content#developing). +Before you begin, follow the steps to install **dependencies and pre-commit hooks** under [Developing Content](https://github.com/splunk/security-content/wiki/Developing-Content). # Security Content @@ -72,7 +72,7 @@ Before you begin, follow the steps to install **dependencies and pre-commit hook * [bin/](bin/): All binaries required to produce and test content # Contribution -We welcome feedback and contributions from the community! Please see our [contribution guidelines](docs/CONTRIBUTING.md) for more information on how to get involved. +We welcome feedback and contributions from the community! Please see our [contributing to the project](https://github.com/splunk/security-content/wiki/Contributing-to-the-Project) for more information on how to get involved. ## Support Please use the [GitHub Issue Tracker](https://github.com/splunk/security-content/issues) to submit bugs or request features. diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md deleted file mode 100644 index 0829e2aa16..0000000000 --- a/docs/CONTRIBUTING.md +++ /dev/null @@ -1,130 +0,0 @@ -# Contributing to the Project - -This document is the single source of truth on how to contribute to this codebase. Please feel free to browse the open issues and file new ones. All feedback is welcome! - ----- - -## Topics - -* [Prerequisites](#prerequisites) - * [Contributor License Agreement](#contributor-license-agreement) - * [Code of Conduct](#code-of-conduct) - * [Setup Development Environment](#setup-development-environment) -* [Contribution Workflow](#contribution-workflow) - * [Feature Requests and Bug Reports](#feature-requests-and-bug-reports) - * [Fixing Issues](#fixing-issues) - * [Pull Requests](#pull-requests) - * [Code Review](#code-review) - * [Documentation](#documentation) -* [Maintainers](#maintainers) - ----- - -## Prerequisites -When contributing to this repository, please first discuss the change you wish to make via a GitHub issue, Slack message, email, or via other channels with the owners of this repository. - -##### Contributor License Agreement -At the moment, we can only accept pull requests submitted from either: -* Splunk employees or -* Individuals that have signed our contributors' agreement - -If you wish to be a contributing member of our community, please see the agreement [for individuals](https://www.splunk.com/goto/individualcontributions) or [for organizations](https://www.splunk.com/goto/contributions). - -##### Code of Conduct -Please make sure to read and observe our [Code of Conduct](contributing/code-of-conduct.md). Please follow it in all of your interactions involving the project. - -##### Setup Development Environment -see [Developing section](https://github.com/splunk/security-content#developing) - -## Contribution Workflow -Help is always welcome! For example, documentation can always use improvement. There's always code that can be clarified, functionality that can be extended, and tests to be added to guarantee behavior. If you see something you think should be fixed, don't be afraid to own it. - -##### Feature Requests and Bug Reports -Have ideas on improvements? See something that needs work? While the community encourages everyone to contribute code, it is also appreciated when someone reports an issue. Please report any issues or bugs you find through [GitHub's issue tracker](https://github.com/splunk/security-content/issues). - -If you are reporting a bug, please include: - -* Your operating system name and version -* Any details about your local setup that might be helpful in troubleshooting (ex. Python interpreter version, Splunk version, etc.) -* Detailed steps to reproduce the bug - -We'd also like to hear about your propositions and suggestions. Feel free to submit them as issues and: - -* Explain in detail how they should work -* Note that keeping the scope as narrow as possible will make the suggestion easier to implement - -##### Fixing Issues -Look through our [issue tracker](https://github.com/splunk/security-content/issues) to find problems to fix! Feel free to comment and tag corresponding stakeholders or full-time maintainers of this project with any questions or concerns. - -##### Pull Requests -What is a "pull request"? It informs the project's core developers about the changes you want to review and merge. Once you submit a pull request, it enters a stage of code review where you and others can discuss its potential modifications and maybe even add more commits to it later on. - -If you want to learn more, please consult this [tutorial on how pull requests work](https://help.github.com/articles/using-pull-requests/) in the [GitHub Help Center](https://help.github.com/). - -Here's an overview of how you can make a pull request against this project: - -1. Fork the [analytic\_story\_execution GitHub repository](https://github.com/splunk/security-content/issues) -2. Clone your fork using git and create a branch off of develop - - ``` - $ git clone git@github.com:YOUR_GITHUB_USERNAME/security-content.git - $ cd security-content - - # This project uses 'develop' for all development activity, so create your branch off that - $ git checkout -b your-bugfix-branch-name develop - ``` - -3. Make your changes, commit, and push (once your tests have passed) - - ``` - $ cd security-content - $ git commit -m "" - $ git push - ``` - -4. Submit a pull request through the GitHub website, using the changes from your forked codebase - -##### Code Review -There are two aspects of code review: giving and receiving. - -To make it easier for your PR to receive reviews, keep in mind that the reviewers will need you to: -* Follow the project coding conventions -* Write good commit messages -* Break large changes into a logical series of smaller patches which individually make easily understandable changes, and in aggregate solve a broader issue - -Reviewers, the people providing the review, are highly encouraged to revisit the [Code of Conduct](contributing/code-of-conduct.md) and must go above and beyond to promote a collaborative, respectful community. - -When reviewing PRs from others, [The Gentle Art of Patch Review](http://sage.thesharps.us/2014/09/01/the-gentle-art-of-patch-review/) suggests an iterative series of focuses designed to lead new contributors to positive collaboration, such as: - -* Is the idea behind the contribution sound? -* Is the contribution architected correctly? -* Is the contribution polished? - -For this project, we require at least one approval. A build from our continuous integration system must also be successful off of your branch. Please note that any new changes made with your existing pull request during review will automatically unapprove and retrigger another build/round of tests. - -##### Documentation -We can always use improvements to our documentation! Anyone can contribute to these docs--whether you’re new to the project, you’ve been around a long time, or if you just can’t stand seeing typos. - -Here's what's needed? - -1. More complementary documentation. Have you something unclear? -2. More examples or generic templates that others can use. -3. Blog posts, articles, and such are all very appreciated. - -You can also edit documentation files directly in the GitHub web interface, without creating a local copy. This can be convenient for small typos or grammar fixes. - -## Maintainers - -If you need help, feel free to tag one of the active maintainers of this project in a post or comment. We'll do our best to reach out to you as quickly as we can. - -``` -# Active maintainers marked with (*) - -(*) Bhavin Patel -(*) David Dorsey -(*) Jose Hernandez -(*) Rico Valdez -(*) Patrick Bareib -(*) Brianna Blacet -``` - diff --git a/docs/contributing/code-of-conduct.md b/docs/contributing/code-of-conduct.md deleted file mode 100644 index 09408f440e..0000000000 --- a/docs/contributing/code-of-conduct.md +++ /dev/null @@ -1,73 +0,0 @@ -## Code of Conduct - -### Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, gender identity and expression, level of experience, -nationality, personal appearance, race, religion, or sexual identity and -orientation. - -### Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or -advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a professional setting - -### Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -### Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -### Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at support@splunk.com. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -### Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at [http://contributor-covenant.org/version/1/4][version] - -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ -