Commit graph

718 commits

Author SHA1 Message Date
tbragin
a23b09ea13 Update and rename docs/asciidoc/static to docs/asciidoc/static/roadmap/index.asciidoc
Fixes #2673
2015-02-24 19:54:49 +00:00
Aaron Mildenstein
3986158bac First pass at cleaning out logstash web
All internal references, flags, kibana, vendor, everything must go!

If it referenced kibana or logstash-web, it is deprecated, and removed!

Operators are standing by...

Fixes #2661
2015-02-20 22:53:18 +00:00
Aaron Mildenstein
481cb27fac Fix per recommendation
closes #2643

Fixes #2660
2015-02-20 19:21:37 +00:00
Aaron Mildenstein
09eefb3db8 Match configuration.asciidoc
Fixes #2660
2015-02-20 19:21:37 +00:00
Aaron Mildenstein
5efca000a9 More changes here to make this visible.
Fixes #2660
2015-02-20 19:21:36 +00:00
Aaron Mildenstein
035b4fe833 Updated the correct file this time
At least the md file is also prettied up with the same information.

Fixes #2660
2015-02-20 19:21:36 +00:00
Aaron Mildenstein
ae0ba8c505 Update documentation to fix #2643
First draft

Fixes #2660
2015-02-20 19:21:36 +00:00
Aaron Mildenstein
e46f2a70ca Added betterspecs ref per @suyograo
Fixes #2659
2015-02-20 18:27:11 +00:00
Aaron Mildenstein
0307d91f1b Additions per review
Fixes #2659
2015-02-20 18:27:11 +00:00
Aaron Mildenstein
c76b2f5d25 Added changes to address #2658
First draft.

Fixes #2659
2015-02-20 18:27:11 +00:00
Kurt Hurtado
6d56067f73 - the +
Fixes #2582
2015-02-11 06:28:31 +00:00
Kurt Hurtado
9ce81e3c82 modify community note
Fixes #2519
2015-02-10 22:42:27 +00:00
Kurt Hurtado
b098f1de7a add reference anchor to config/field-references
Fixes #2519
2015-02-10 22:42:27 +00:00
Kurt Hurtado
4b0f5ee521 add asciidoc NOTE: for community-supported plugins
Fixes #2519
2015-02-10 22:42:27 +00:00
Aaron Mildenstein
fd5065b711 Template update to prevent spacing error
The spacing error would put the closing curly brace indented
if there were no options, and only for codecs.  This puts an
`if` in place to prevent that.

Fixes #2513
2015-02-05 22:24:22 +00:00
Aaron Mildenstein
6ade9a949e Update to documentation templates
This update presents alternate text if no configuration options
exist for a plugin.

It even hides the Details section if there are no configuration
parameters.

Fixes #2513
2015-02-05 22:24:22 +00:00
Aaron Mildenstein
bcff5dd66b Update to fix logstash-docs 42
See: https://github.com/elasticsearch/logstash-docs/issues/42

The teardown method is in the base class now, so it's
commented out.

Fixes #2511
2015-02-05 00:27:24 +00:00
Aaron Mildenstein
dca3224732 Add vendor.json and jar dependency info
Added jar dependencies gem

s.add_runtime_dependency 'jar-dependencies'

Add comments per Jordan

Fixes #2502
2015-02-03 18:46:09 +00:00
Aaron Mildenstein
600d07c607 Actually push out changes
facepalm merge...

Fixes #2496
2015-02-02 23:30:19 +00:00
Aaron Mildenstein
13abdd3db8 Removing deprecated docs, updating other.
This change now reflects the changes for 1.5, including that
contrib is going away, as are milestones.

The new doc is not "extending-logstash" but "contributing to"

Fixes #2495
2015-02-02 23:10:08 +00:00
Aaron Mildenstein
90c8f63ee3 Fix some url evaluation due to monospace quoting
Fixes #2481
2015-01-30 01:01:16 +00:00
Aaron Mildenstein
db437d51bd Fix a few missed passthroughs
Fixes #2480
2015-01-30 00:27:05 +00:00
Aaron Mildenstein
8cd25d1b73 Discovery of monospace quoting
Apparently, if you encapsulate text within + symbols, it will be
monospaced.  This allows me to use the pass:attributes[{macroname}]
within these quotes without the previously resulting errors!

YAY!

Fixes #2479
2015-01-29 23:35:30 +00:00
Aaron Mildenstein
d27958f495 Removed nested inline passthrough errors
Fixes #2479
2015-01-29 23:35:30 +00:00
Aaron Mildenstein
f006406f38 Remove deprecated doc
Fixes #2478
2015-01-29 22:09:44 +00:00
Aaron Mildenstein
5a5ebd7e58 Add [float] to section headers
This fixes some crazy asciidoc => docbook XML => html conversion
stuff that our current doc process uses.

Fixes #2478
2015-01-29 22:09:44 +00:00
Aaron Mildenstein
026b8c8812 Rough draft: First commit of new plugin howto docs
Update spacing at top to be pretty

Consolidated global macros to pluginbody.asciidoc

The `:branch:` and `:ls_version:` macros are now globally set
in the pluginbody.asciidoc file.

Also, updated more `:validate` options to include `:path`, and more.

Updated doc per comment #r23179489

https://github.com/elasticsearch/logstash/pull/2365/files#r23179489

Added ruby-gem tree examples per Suyog

See https://github.com/elasticsearch/logstash/pull/2365/files#r23180872

Removed docs suggesting the removal of README.md

We should keep the README.md which will come with the example
repository, per https://github.com/elasticsearch/logstash/pull/2365/files#r23181348
Also see https://github.com/elasticsearch/logstash/issues/2043#issuecomment-70183183

Add a section on inline documentation

See https://github.com/elasticsearch/logstash/pull/2365/files#r23181473
and https://github.com/elasticsearch/logstash/issues/2043#issuecomment-70183183

Added blurb about how plugins are independent

They're independent of the Logstash core, are ruby gems, and can
be installed and upgraded independent of the Logstash core version.

Improved wording a bit.

See https://github.com/elasticsearch/logstash/pull/2365/files#r23180537

Added notice about adding Asciidoc documentation

Fixed some rendering bugs so it renders cleanly now.

See https://github.com/elasticsearch/logstash/pull/2365/files#r23181473

Migrated the introfooter and changed the macro

See https://github.com/elasticsearch/logstash/pull/2365/files#r23180410

Playing with formatting

Moved things around and started playing with admonition paragraphs and blocks.

Converted example plugin import instructions

Now they're in an admonition block with callouts

Logstash plugins are written in ruby.

Change per Jordan. https://github.com/elasticsearch/logstash/pull/2365/files#r23246549

intented => intended.

See https://github.com/elasticsearch/logstash/pull/2365/files#r23247409

Instructions for git via http(s) or ssh

See https://github.com/elasticsearch/logstash/pull/2365/files#r23248170

Added alternate http method in callout

See https://github.com/elasticsearch/logstash/pull/2365/files#r23248170

Updated to default to http cloning method

This is because it's dead-simple for cloning the example repos.
See: https://github.com/elasticsearch/logstash/pull/2365/files#r23248170

Address #r23267565

https://github.com/elasticsearch/logstash/pull/2365/files#r23267565

Use "must implement"

See: https://github.com/elasticsearch/logstash/pull/2365/files#r23267755
and https://github.com/elasticsearch/logstash/pull/2365/files#r23267810

Change header lede

See: https://github.com/elasticsearch/logstash/pull/2365/files#r23267872

Reword intro

See: https://github.com/elasticsearch/logstash/pull/2365/files#r23268058

Updated per #r23274719

https://github.com/elasticsearch/logstash/pull/2365/files#r23274719

Update per #r23274830

https://github.com/elasticsearch/logstash/pull/2365/files#r23274830

Changes per recommendation

https://github.com/elasticsearch/logstash/pull/2365/files#r23274874
https://github.com/elasticsearch/logstash/pull/2365/files#r23274934

Fix encoding and require sections

https://github.com/elasticsearch/logstash/pull/2365/files#r23275116
https://github.com/elasticsearch/logstash/pull/2365/files#r23275242

Typo and style changes

https://github.com/elasticsearch/logstash/pull/2365/files#r23275274
https://github.com/elasticsearch/logstash/pull/2365/files#r23275315

Lots of style fixes per debadair

Style fix for ugly text

Another patch (didn't like the last one still)

Superfluous is.

Block formatting of sections

See: https://github.com/elasticsearch/logstash/pull/2365/files#r23417997

Remove the ambiguity of a/an

Added publishing info

Lots of refactoring of the testing outputs.
Several ordering and formatting changes.

Fix word order in introduction

Fixed a formatting error (missing newline)

Added some versioning information.

I am removing the superfluous "the"s

Even more touch-ups and changes

Changes per Suyog

Changes per Kurt

Fix details found by Kurt

Fixes and typos per Kurt

Small change the -> your

Fixes #2365
2015-01-29 17:47:23 +00:00
debadair
47dc52c9a7 Incorporated Suyog's feedback.
Fixes #2364
2015-01-20 19:19:29 +00:00
debadair
9ae861c014 Split pipeline overview and config file examples out of the Getting Started topic.
Fixes #2364
2015-01-20 19:19:29 +00:00
debadair
c8d78f5fb3 Editing/cleanup pass through the logstash docs. 2015-01-15 15:23:05 -08:00
Tal Levy
c3bab9d896 add support for :bytes validation to config
Fixes #2321
2015-01-15 19:53:31 +00:00
Richard Klafter
8f85738bcf Small change so apt-transport-https package is not required on Debian. Yum supports https by default.
Fixes #2243
2014-12-18 20:46:41 +00:00
Richard Klafter
adfb51bafb updates docs to fix #2240
Fixes #2243
2014-12-18 20:46:40 +00:00
Adrien nayrat
a785a69ae9 Add comment for locale in date filter.
For non-english environment the date filter don't parse correctly the month name. See : http://stackoverflow.com/questions/26653490/logstash-date-filter-failed-parsing

Fixes #1987
2014-12-18 01:51:47 +00:00
Richard Pijnenburg
14832da1b7 Fix docgen with correct path to gem's
Fixes #2251
2014-12-16 17:00:50 +00:00
Wiibaa
4e36552455 Correct links to plugin sources
Fixes #2164
2014-12-14 02:25:24 +00:00
Kurt Hurtado
a88624bab7 expand attributes in ListingBlocks, sync to logstash-docs version
Fixes #2216
2014-12-10 23:50:44 +00:00
Pere Urbon-Bayes
93b282f01c add a reference to the plugins page within the logstash getting started tutorial
Fixes #2109
2014-12-02 06:08:55 +00:00
Pere Urbon-Bayes
2948888a63 fix the release notes ascii docs style
Fixes #2109
2014-12-02 06:08:55 +00:00
Pere Urbon-Bayes
91c6a80878 clean up some reference to logstash.net in benefit of the es site
Fixes #2109
2014-12-02 06:08:55 +00:00
Pere Urbon-Bayes
887758b3f8 fix doc inconsistency about the versions in the getting started guide
Fixes #2109
2014-12-02 06:08:55 +00:00
Suyog Rao
82a335ec48 Fix after @electrical changes
Fixes #2068
2014-11-13 16:45:53 +00:00
Suyog Rao
40ad1bb0f7 Fix for missing type links in generated docs
Fixes #2068
2014-11-13 16:45:53 +00:00
Richard Pijnenburg
86037bba0e Modify static docs to work with Generated plugin docs
Fixes #2067
2014-11-13 15:46:43 +00:00
Richard Pijnenburg
18b8cec2b4 Update templates
- Fix empty lines
- Add some more text

Fixes #2045
2014-11-13 15:09:39 +00:00
Richard Pijnenburg
91e7f82798 Some plugin generation fixes.
- Ensure empty lines in some places
- Only print the table if we actually have items to put in there
- Always use inspect function when printing out the defaults

Fixes #2045
2014-11-13 15:09:39 +00:00
Paul Echeverri
1e4c0288ea Handling feedback for PR#2041 2014-11-07 16:09:32 -08:00
Paul Echeverri
17f902eafb Changes to generated docs and their templates. 2014-11-07 16:09:32 -08:00
Suyog Rao
24d03b4bce Fix asciidoc link to string reference
Fixes #2038
2014-11-07 22:35:20 +00:00
Richard Pijnenburg
56eb71ca1f Some documentation generation fixes
- Add docgen command to use internal libraries
- Fix loading of base files due to plugin path changes
- Fix loading of jar dependency files
- Remove kramdown gem and actions
- Cleanup the generated synopsis a bit

Fixes #2009
2014-11-03 20:23:39 +00:00