Skip to content

Commit

Permalink
Note doc file created with plugin generation
Browse files Browse the repository at this point in the history
  • Loading branch information
karenzone committed Apr 26, 2019
1 parent 229b124 commit 5485360
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/static/doc-for-plugin.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ in the {logstash-ref}/index.html[Logstash Reference] and the
[[plugin-doc-file]]
==== Documentation file

Include documentation in your plugin structure as a single file called 'docs/index.asciidoc'.
Documentation is a required component of your plugin.
It belongs in a single file called 'docs/index.asciidoc'.
The <<plugin-generator,plugin generation utility>> creates a starter file for you.

[[heading-ids]]
==== Heading IDs
Expand Down Expand Up @@ -79,7 +81,7 @@ Use external link syntax for links that point to documentation for other plugins
{logstash-ref}/getting-started-with-logstash.html
-----

===== Links specifying link text
===== Link text

If you don't specify link text, the URL is used as the link text.

Expand Down

0 comments on commit 5485360

Please sign in to comment.