Skip to content

Commit b256f04

Browse files
committed
License 2016 and new plugin installing command
1 parent f8664d1 commit b256f04

6 files changed

+88
-3
lines changed

.github/CONTRIBUTING.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributing to Logstash
2+
3+
All contributions are welcome: ideas, patches, documentation, bug reports,
4+
complaints, etc!
5+
6+
Programming is not a required skill, and there are many ways to help out!
7+
It is more important to us that you are able to contribute.
8+
9+
That said, some basic guidelines, which you are free to ignore :)
10+
11+
## Want to learn?
12+
13+
Want to lurk about and see what others are doing with Logstash?
14+
15+
* The irc channel (#logstash on irc.freenode.org) is a good place for this
16+
* The [forum](https://discuss.elastic.co/c/logstash) is also
17+
great for learning from others.
18+
19+
## Got Questions?
20+
21+
Have a problem you want Logstash to solve for you?
22+
23+
* You can ask a question in the [forum](https://discuss.elastic.co/c/logstash)
24+
* Alternately, you are welcome to join the IRC channel #logstash on
25+
irc.freenode.org and ask for help there!
26+
27+
## Have an Idea or Feature Request?
28+
29+
* File a ticket on [GitHub](https://github.com/elastic/logstash/issues). Please remember that GitHub is used only for issues and feature requests. If you have a general question, the [forum](https://discuss.elastic.co/c/logstash) or IRC would be the best place to ask.
30+
31+
## Something Not Working? Found a Bug?
32+
33+
If you think you found a bug, it probably is a bug.
34+
35+
* If it is a general Logstash or a pipeline issue, file it in [Logstash GitHub](https://github.com/elasticsearch/logstash/issues)
36+
* If it is specific to a plugin, please file it in the respective repository under [logstash-plugins](https://github.com/logstash-plugins)
37+
* or ask the [forum](https://discuss.elastic.co/c/logstash).
38+
39+
# Contributing Documentation and Code Changes
40+
41+
If you have a bugfix or new feature that you would like to contribute to
42+
logstash, and you think it will take more than a few minutes to produce the fix
43+
(ie; write code), it is worth discussing the change with the Logstash users and developers first! You can reach us via [GitHub](https://github.com/elastic/logstash/issues), the [forum](https://discuss.elastic.co/c/logstash), or via IRC (#logstash on freenode irc)
44+
Please note that Pull Requests without tests will not be merged. If you would like to contribute but do not have experience with writing tests, please ping us on IRC/forum or create a PR and ask our help.
45+
46+
## Contributing to plugins
47+
48+
Check our [documentation](https://www.elastic.co/guide/en/logstash/current/contributing-to-logstash.html) on how to contribute to plugins or write your own! It is super easy!
49+
50+
## Contribution Steps
51+
52+
1. Test your changes! [Run](https://github.com/elastic/logstash#testing) the test suite
53+
2. Please make sure you have signed our [Contributor License
54+
Agreement](https://www.elastic.co/contributor-agreement/). We are not
55+
asking you to assign copyright to us, but to give us the right to distribute
56+
your code without restriction. We ask this of all contributors in order to
57+
assure our users of the origin and continuing existence of the code. You
58+
only need to sign the CLA once.
59+
3. Send a pull request! Push your changes to your fork of the repository and
60+
[submit a pull
61+
request](https://help.github.com/articles/using-pull-requests). In the pull
62+
request, describe what your changes do and mention any bugs/issues related
63+
to the pull request.
64+
65+

.github/ISSUE_TEMPLATE.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Please post all product and debugging questions on our [forum](https://discuss.elastic.co/c/logstash). Your questions will reach our wider community members there, and if we confirm that there is a bug, then we can open a new issue here.
2+
3+
For all general issues, please provide the following details for fast resolution:
4+
5+
- Version:
6+
- Operating System:
7+
- Config File (if you have sensitive info, please remove it):
8+
- Sample Data:
9+
- Steps to Reproduce:

.github/PULL_REQUEST_TEMPLATE.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Thanks for contributing to Logstash! If you haven't already signed our CLA, here's a handy link: https://www.elastic.co/contributor-agreement/

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
1+
Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
22

33
Licensed under the Apache License, Version 2.0 (the "License");
44
you may not use this file except in compliance with the License.

README.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,12 @@ gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
6767
```
6868
- Install plugin
6969
```sh
70+
# Logstash 2.3 and higher
71+
bin/logstah-plugin install --no-verify
72+
73+
# Prior to Logstash 2.3
7074
bin/plugin install --no-verify
75+
7176
```
7277
- Run Logstash with your plugin
7378
```sh
@@ -85,7 +90,12 @@ gem build logstash-filter-awesome.gemspec
8590
```
8691
- Install the plugin from the Logstash home
8792
```sh
88-
bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
93+
# Logstash 2.3 and higher
94+
bin/logstah-plugin install --no-verify
95+
96+
# Prior to Logstash 2.3
97+
bin/plugin install --no-verify
98+
8999
```
90100
- Start Logstash and proceed to test the plugin
91101

logstash-output-elasticsearch.gemspec

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
44
s.version = '2.6.2'
55
s.licenses = ['apache-2.0']
66
s.summary = "Logstash Output to Elasticsearch"
7-
s.description = "Output events to elasticsearch"
7+
s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
88
s.authors = ["Elastic"]
99
s.email = '[email protected]'
1010
s.homepage = "http://logstash.net/"

0 commit comments

Comments
 (0)