github-mirrors/logstash
1
0
Fork 0
mirror of https://github.com/elastic/logstash.git synced 2025-04-24 22:57:16 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Doc][Backport]Asciidoctor formatting changes for ls ref 5.3 (#10767)

Browse source 
* Asciidoctor formatting changes for ls ref
* Asciidoctor formatting changes to plugin-manager
This commit is contained in:
Karen Metts 2019-05-10 15:28:57 -04:00 • committed by GitHub
parent 93a28254e0
commit 69988485fc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 19 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/static/advanced-pipeline.asciidoc vendored
View file

@ -47,7 +47,6 @@ filebeat.prospectors:
output.logstash: output.logstash:
hosts: ["localhost:5043"] hosts: ["localhost:5043"]
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
<1> Absolute path to the file or files that Filebeat processes. <1> Absolute path to the file or files that Filebeat processes.
Save your changes. Save your changes.
@ -690,7 +689,6 @@ filebeat.prospectors:
output.logstash: output.logstash:
hosts: ["localhost:5043"] hosts: ["localhost:5043"]
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
<1> Absolute path to the file or files that Filebeat processes. <1> Absolute path to the file or files that Filebeat processes.
<2> Adds a field called `type` with the value `syslog` to the event. <2> Adds a field called `type` with the value `syslog` to the event.

30
docs/static/maintainer-guide.asciidoc vendored
View file

@ -110,27 +110,27 @@ Please see following annotated example and see a concrete example in https://raw
[source,markdown] [source,markdown]
---- ----
## 1.0.x // <1> <2> ## 1.0.x // <1>
- change description // <3> - change description // <2>
- tag: change description // <3> <4> - tag: change description // <3>
- tag1,tag2: change description // <3> <5> - tag1,tag2: change description // <4>
- tag: Multi-line description // <3> <6> - tag: Multi-line description // <5>
must be indented and can use must be indented and can use
additional markdown syntax additional markdown syntax
// <7> // <6>
## 1.0.0 // <8> ## 1.0.0 // <7>
[...] [...]
---- ----
<1> Latest version is the first line of CHANGELOG.md <1> Latest version is the first line of CHANGELOG.md.
<2> Each version identifier should be a level-2 header using `##` Each version identifier should be a level-2 header using `##`
<3> One change description is described as a list item using a dash `-` aligned under the version identifier <2> One change description is described as a list item using a dash `-` aligned under the version identifier
<4> One change can be tagged by a word and suffixed by `:`. + <3> One change can be tagged by a word and suffixed by `:`. +
Common tags are `bugfix`, `feature`, `doc`, `test` or `internal`. Common tags are `bugfix`, `feature`, `doc`, `test` or `internal`.
<5> One change can have multiple tags separated by a comma and suffixed by `:` <4> One change can have multiple tags separated by a comma and suffixed by `:`
<6> A multi-line change description must be properly indented <5> A multi-line change description must be properly indented
<7> Please take care to *separate versions with an empty line* <6> Please take care to *separate versions with an empty line*
<8> Previous version identifier <7> Previous version identifier
[float] [float]
==== Continuous Integration ==== Continuous Integration

2
docs/static/plugin-generator.asciidoc vendored
View file

@ -8,7 +8,7 @@ can start adding custom code to process data with Logstash.
**Example Usage** **Example Usage**
[source,sh] [source,sh]
-------------------------------------------- -------------------------------------------
bin/logstash-plugin generate --type input --name xkcd --path ~/ws/elastic/plugins bin/logstash-plugin generate --type input --name xkcd --path ~/ws/elastic/plugins
------------------------------------------- -------------------------------------------

4
docs/static/plugin-manager.asciidoc vendored
View file

@ -21,11 +21,8 @@ bin/logstash-plugin list '*namefragment*' <3>
bin/logstash-plugin list --group output <4> bin/logstash-plugin list --group output <4>
---------------------------------- ----------------------------------
<1> Will list all installed plugins <1> Will list all installed plugins
<2> Will list installed plugins with version information <2> Will list installed plugins with version information
<3> Will list all installed plugins containing a namefragment <3> Will list all installed plugins containing a namefragment
<4> Will list all installed plugins for a particular group (input, filter, codec, output) <4> Will list all installed plugins for a particular group (input, filter, codec, output)
[float] [float]
@ -83,7 +80,6 @@ bin/logstash-plugin update <1>
bin/logstash-plugin update logstash-output-kafka <2> bin/logstash-plugin update logstash-output-kafka <2>
---------------------------------- ----------------------------------
<1> will update all installed plugins <1> will update all installed plugins
<2> will update only this plugin <2> will update only this plugin
[[removing-plugins]] [[removing-plugins]]

6
docs/static/running-logstash.asciidoc vendored
View file

@ -24,7 +24,7 @@ Distributions like Debian Jessie, Ubuntu 15.10+, and many of the SUSE derivative
`systemctl` command to start and stop services. Logstash places the systemd unit files in `/etc/systemd/system` for both deb and rpm. After installing the package, you can start up Logstash with: `systemctl` command to start and stop services. Logstash places the systemd unit files in `/etc/systemd/system` for both deb and rpm. After installing the package, you can start up Logstash with:
[source,sh] [source,sh]
-------------------------------------------- -------------------------------------------
sudo systemctl start logstash.service sudo systemctl start logstash.service
------------------------------------------- -------------------------------------------
@ -34,7 +34,7 @@ sudo systemctl start logstash.service
For systems that use upstart, you can start Logstash with: For systems that use upstart, you can start Logstash with:
[source,sh] [source,sh]
-------------------------------------------- -------------------------------------------
sudo initctl start logstash sudo initctl start logstash
------------------------------------------- -------------------------------------------
@ -46,7 +46,7 @@ The auto-generated configuration file for upstart systems is `/etc/init/logstash
For systems that use SysV, you can start Logstash with: For systems that use SysV, you can start Logstash with:
[source,sh] [source,sh]
-------------------------------------------- -------------------------------------------
sudo /etc/init.d/logstash start sudo /etc/init.d/logstash start
------------------------------------------- -------------------------------------------