Commit graph

15 commits

Author SHA1 Message Date
Pier-Hugues Pellerin
0e97216b9f Make the TODO ignore the presence of :
Fixes #6777
2017-03-02 20:21:16 -05:00
Pier-Hugues Pellerin
321e59133e Fix an issue with handling the plugin type with new style declaration
Correctly extract the plugin type when the plugin is defined with

```
module LogStash module Inputs class XXX < ...
```

Fixes #6777
2017-03-02 20:21:16 -05:00
Suyog Rao
6402b898c1 [docs gen] Format description to be at the right level 2017-02-18 16:11:20 -08:00
Pier-Hugues Pellerin
504cfce2cb Remove the default column in the plugin doc page to give space to the sidebar (#6715)
* Remove the default column in the plugin doc page to give space to the
sidebar

Fix: #6515
2017-02-18 15:41:33 -08:00
Pier-Hugues Pellerin
df36c40457 Support license in the docgen if they are at the beginning of the document remove the logger statement in the generate file
Fixes #6714
2017-02-16 10:00:29 -05:00
Pier-Hugues Pellerin
63dd6d7e17 Fix a few issues when using the logstash-docgen tools
Fixes the following issues:

- Make multiline plugin definition correctly take the description See
rabbit mq input or output
- Use a regexp to ignore encoding comment
- Use `TODO` The doc gen will now ignore some TODOs.
- rules are now executed in the correct order,
- make sure to ignore comment not associated with a descrition of an
attributes

Ref: #6692

Fixes #6714
2017-02-16 10:00:29 -05:00
Pier-Hugues Pellerin
a7c456e212 fix devutils weird ordering.
Fixes #6714
2017-02-16 10:00:29 -05:00
Pier-Hugues Pellerin
1d78b54f84 Change plugin templates
This PR changes the following:

- Change the wording for non default plugin
- Add a link to a help section

Fixes #6719
2017-02-16 09:57:54 -05:00
Pier-Hugues Pellerin
080c8ac8bf Change the release date format on the plugin doc template
The new format will be this one: February 7, 2017

Fixes #6717
2017-02-16 09:56:43 -05:00
Suyog Rao
691179f719 Better asciidoc formatting and text for ID option
Fixes #6679
2017-02-09 14:39:21 -05:00
Pier-Hugues Pellerin
bdba81b199 remove compatible line until we have per plugin book
Fixes #6678
2017-02-09 14:24:12 -05:00
Clinton Gormley
2e0f982a52 Changed the format of generated edit_urls and removed unneeded ones
# Conflicts:
#	docs/index.asciidoc
2017-02-04 16:11:13 +01:00
Alvin Chen
ac66402f12 Remove community maintained statement
Remove community maintained statement

Fixes #6365
2016-12-06 17:00:35 -05:00
Jordan Sissel
a40f686d7b Pin webmock to 2.2.0
The latest version of webmock (2.3.1) requires Ruby 2.0 or newer.

Fixes #6362
2016-12-06 14:08:34 -05:00
Pier-Hugues Pellerin
fe8c438b24 Logstash-docgen tool v2
**Motivation**: We have decided to rewrite the documentation generator to add more features
to our documentation and to fix some outstanding bugs.

This PR addresses the following problem:
- Hard to add new features to the code base.
- The code was tied with Logstash.
- No easy way to publish the doc for a single plugin
- The plugin author was not able to test their documentation changes
- The reported errors were hard to understand.
- No easy way to automate it.
- the minimal requirement on base classes.

Fixes #5720
2016-11-30 19:57:40 -05:00