Unverified Commit 7f2285c7 authored by Ben Abrams's avatar Ben Abrams
Browse files

adding additional CONTRIBUTING.md to help outline process a bit better

parent 1cde6667
Contributing to cookbook-elasticsearch
======================================
### Workflow for contributing
1. Create a branch directly in this repo or a fork (if you don't have push access). Please name branches within this repository `<fix type>/<description>`. For example, something like feature/install_from_deb.
1. Create an issue or open a PR. If you aren't sure your PR will solve the issue, or may be controversial, we commend opening an issue separately and linking to it in your PR, so that if the PR is not accepted, the issue will remain and be tracked.
1. Close (and reference) issues by the `closes #XXX` or `fixes #XXX` notation in the commit message. Please use a descriptive, useful commit message that could be used to understand why a particular change was made.
1. Keep pushing commits to the initial branch, `--amend`-ing if necessary. Please don't mix fixing unrelated issues in a single branch.
1. Create a changelog entry as per [Keep A Changelog](http://keepachangelog.com/). You should only be putting new stuff under `## [Unreleased]` and should not concern yourself with bumping the version and dates as this will be done when releasing changes. When you need to have a change that will break things it needs to be called out with a `### Breaking Changes` as opposed to a more common header such as `### Added, ### Fixed, ### Changed`. This helps maintainers evaluate what the appropriate version bump should be as there could be changes that are not immediately released.
1. When everything is ready for merge, clean up the branch (rebase with master to synchronize, squash, edit commits, etc) to prepare for it to be merged. Unless you have meaningful history it should be a single commit. Prefer a rebase to a merge for brining in changes that have been committed to upstream master.
### Merging contributions
1. After reviewing commits for documentation, passing CI tests, and good descriptive commit messages, merge it with either "squash and merge" or "rebase and merge" do not use the
"merge pull request" as it does not do a fast forward first.
### Releasing
1. Create/update the changelog entries and evaluate the type of release.
1. create a git release with something like hub, example: `hub release create vMajor.Minor.patch`
......@@ -12,7 +12,7 @@ installer and on Windows uses the exe installer. Here are the steps it follows:
3. Runs installer
4. Starts collector and registers with the Sumo Logic service
For collector update, the existing collector must have been switched to use Local Configuration Mangement - see the instructions to
For collector update, the existing collector must have been switched to use Local Configuration Mangement - see the instructions to
configure [New Collectors](https://help.sumologic.com/Send_Data/Local_Configuration_File_Management/Local_File_Configuration_Management_for_New_Collectors_and_Sources)
or [Existing Collectors](https://help.sumologic.com/Send_Data/Local_Configuration_File_Management/Local_Configuration_File_Management_for_Existing_Collectors_and_Sources)
for more details. The steps the cookbook follows:
......@@ -29,9 +29,9 @@ Edit `sumo.json` (or the json files under the json folder) to add/edit/remove so
Note
------
Starting from 19.107, there are 2 major extensions to SumoLogic collectors:
* You can configure a collector's parameters from a set of json files under a common folder. Each of the json file will represent a source on that collector. Updates made to a json file will then be reflected on its corresponding source. Note that the format of this kind of file is **slightly different** from that of the traditional single json file (sumo.json) and they are **not** compatible. You also need to use the parameter `syncSources` instead of `sources` inside `sumo.conf`.
* You can configure a collector's parameters from a set of json files under a common folder. Each of the json file will represent a source on that collector. Updates made to a json file will then be reflected on its corresponding source. Note that the format of this kind of file is **slightly different** from that of the traditional single json file (sumo.json) and they are **not** compatible. You also need to use the parameter `syncSources` instead of `sources` inside `sumo.conf`.
See more details [here](https://help.sumologic.com/Send_Data/Installed_Collectors/sumo.conf).
* You can change a collector's existing parameters through local configuration json file(s) continuously. Before this, using collector API was the only option.
* You can change a collector's existing parameters through local configuration json file(s) continuously. Before this, using collector API was the only option.
More information about this is [here](https://help.sumologic.com/Send_Data/Local_Configuration_File_Management)
Installation
......@@ -543,9 +543,7 @@ end
Contributing
------------
This cookbook is meant to help customers use Chef to install Sumo Logic
collectors, so please feel to fork this repository, and make whatever changes
you need for your environment.
Please see CONTRIBUTING.md for guidelines
License and Authors
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment