Commit graph

22 commits

Author SHA1 Message Date
Joao Duarte
d0f1ed4c71 Revert "replace with_clean_env with with_unbundled_env (#12615) (#12618)"
This reverts commit ff3cf929fa.

Because we're still on bundler 1.x here..
2021-01-29 17:56:58 +00:00
João Duarte
ff3cf929fa
replace with_clean_env with with_unbundled_env (#12615) (#12618)
(cherry picked from commit 023e11a8e2)
2021-01-29 17:35:47 +00:00
João Duarte
1fc169b7f6 Add apache and elastic license headers to source code files (#11673)
* add license header to ruby and java files
* add license header to erb and rake files
* add license headers to gradle files
2020-03-11 11:54:32 +00:00
João Duarte
593235c162 Update rack dependency on docgen project
Fixes #11644
2020-03-03 13:57:35 +00:00
Pier-Hugues Pellerin
42e9c0d758 Extraction of the document from ruby to actual asciidoc file
This PR is based on the proposal from #6846, it does the following

- Change the format of the plugin help page
- Create an external file for each plugin type that will get included by the plugin
- Add a script to generate the PR on each plugin repo with the static doc
- Add a script `ci/ci_docs.sh` that will be used to generate the list of plugins that can be installed in logstash from all the available plugins from the community organization

This PR is the building block for change in https://github.com/elastic/docs-tools/issues/3

Fixes #6941
2017-06-08 20:14:36 +00:00
Josh Soref
a06dc211ff Spelling fixes (#6806)
Spelling fixes across the board.
2017-03-29 19:33:26 -07:00
Pier-Hugues Pellerin
bab13fbc84 Make the TODO ignore the presence of :
Fixes #6777
2017-03-02 20:21:15 -05:00
Pier-Hugues Pellerin
1ec317b48a 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:15 -05:00
Suyog Rao
9cc165a428 [docs gen] Format description to be at the right level 2017-02-18 16:09:55 -08:00
Pier-Hugues Pellerin
aa0793417a 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:40:02 -08:00
Pier-Hugues Pellerin
2d3a2c28c7 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
e795552c6b 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:28 -05:00
Pier-Hugues Pellerin
f3a263d5f6 fix devutils weird ordering.
Fixes #6714
2017-02-16 10:00:28 -05:00
Pier-Hugues Pellerin
2bb986a80b 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:53 -05:00
Pier-Hugues Pellerin
b5580d6f4b 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
Jordan Sissel
0ee1612fb1 Pin gems gem to 0.8.3
Fixes this error:

    % bundle install
    ...
    Installing gems 1.0.0
    Gem::InstallError: gems requires Ruby version >= 2.1.9.

Fixes #6681
2017-02-09 14:57:42 -05:00
Suyog Rao
7a302d1064 Better asciidoc formatting and text for ID option
Fixes #6679
2017-02-09 14:39:20 -05:00
Pier-Hugues Pellerin
b218eaba41 remove compatible line until we have per plugin book
Fixes #6678
2017-02-09 14:24:11 -05:00
Clinton Gormley
83ce954e68 Changed the format of generated edit_urls and removed unneeded ones 2017-02-04 16:09:33 +01:00
Alvin Chen
6e527b26ec Remove community maintained statement
Remove community maintained statement

Fixes #6365
2016-12-06 17:00:34 -05:00
Jordan Sissel
3cc5d3cf32 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:07:46 -05:00
Pier-Hugues Pellerin
bf2d670d2a 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