From 6500917f7a4cbf3420712e139b5f11f7f4679be0 Mon Sep 17 00:00:00 2001 From: Clinton Gormley Date: Sat, 4 Feb 2017 16:07:58 +0100 Subject: [PATCH] Changed the format of generated edit_urls and removed unneeded ones # Conflicts: # docs/index.asciidoc --- docs/index.asciidoc | 63 +++++++++---------- docs/static/include/pluginbody.asciidoc | 4 +- docs/static/submitting-a-plugin.asciidoc | 2 +- .../templates/index-codecs.asciidoc.erb | 6 +- .../templates/index-filters.asciidoc.erb | 6 +- .../templates/index-inputs.asciidoc.erb | 4 +- .../templates/index-outputs.asciidoc.erb | 4 +- 7 files changed, 43 insertions(+), 46 deletions(-) diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 7b899f993..727df9cc0 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -37,120 +37,117 @@ volume and variety of data. // The pass blocks here point to the correct repository for the edit links in the guide. // Introduction -pass::[] + include::static/introduction.asciidoc[] // Glossary and core concepts go here // Getting Started with Logstash -pass::[] + include::static/getting-started-with-logstash.asciidoc[] // Advanced LS Pipelines -pass::[] + include::static/advanced-pipeline.asciidoc[] // Processing Pipeline -pass::[] + include::static/life-of-an-event.asciidoc[] // Lostash setup -pass::[] + include::static/setting-up-logstash.asciidoc[] -pass::[] + include::static/docker.asciidoc[] -pass::[] + include::static/settings-file.asciidoc[] -pass::[] + include::static/command-line-flags.asciidoc[] -pass::[] + include::static/logging.asciidoc[] -pass::[] + include::static/persistent-queues.asciidoc[] -pass::[] + include::static/shutdown.asciidoc[] // Breaking Changes -pass::[] + include::static/breaking-changes.asciidoc[] // Upgrading Logstash -pass::[] + include::static/upgrading.asciidoc[] // Configuring Logstash -pass::[] + include::static/configuration.asciidoc[] -pass::[] + include::static/reloading-config.asciidoc[] -pass::[] + include::static/managing-multiline-events.asciidoc[] -pass::[] + include::static/glob-support.asciidoc[] // Deploying & Scaling -pass::[] + include::static/deploying.asciidoc[] // Troubleshooting performance -pass::[] + include::static/performance-checklist.asciidoc[] // Monitoring APIs -pass::[] + include::static/monitoring-apis.asciidoc[] // Working with Plugins -pass::[] + include::static/plugin-manager.asciidoc[] // These files do their own pass blocks -pass::[] + include::plugins/inputs.asciidoc[] include::plugins/outputs.asciidoc[] include::plugins/filters.asciidoc[] include::plugins/codecs.asciidoc[] +:edit_url: + // Contributing to Logstash -pass::[] + include::static/contributing-to-logstash.asciidoc[] -// This is in the pluginbody.asciidoc itself -pass::[] include::static/input.asciidoc[] include::static/codec.asciidoc[] include::static/filter.asciidoc[] include::static/output.asciidoc[] // Contributing a Patch to a Logstash Plugin -pass::[] + include::static/contributing-patch.asciidoc[] // Logstash Community Maintainer Guide -pass::[] + include::static/maintainer-guide.asciidoc[] // A space is necessary here ^^^ -pass::[] + // Submitting a Plugin -pass::[] + include::static/submitting-a-plugin.asciidoc[] -// This is in the pluginbody.asciidoc itself -// pass::[] - // Glossary of Terms -pass::[] + include::static/glossary.asciidoc[] diff --git a/docs/static/include/pluginbody.asciidoc b/docs/static/include/pluginbody.asciidoc index 4a31f014e..94afd5731 100644 --- a/docs/static/include/pluginbody.asciidoc +++ b/docs/static/include/pluginbody.asciidoc @@ -1,4 +1,4 @@ -pass::[] + === How to write a Logstash {plugintype} plugin @@ -1299,4 +1299,4 @@ the Logstash repository. When the acceptance guidelines are completed, we will facilitate the move to the logstash-plugins organization using the recommended https://help.github.com/articles/transferring-a-repository/#transferring-from-a-user-to-an-organization[github process]. -pass::[] + diff --git a/docs/static/submitting-a-plugin.asciidoc b/docs/static/submitting-a-plugin.asciidoc index d85db91a8..8de77da37 100644 --- a/docs/static/submitting-a-plugin.asciidoc +++ b/docs/static/submitting-a-plugin.asciidoc @@ -104,4 +104,4 @@ the Logstash repository. When the acceptance guidelines are completed, we will facilitate the move to the logstash-plugins organization using the recommended https://help.github.com/articles/transferring-a-repository/#transferring-from-a-user-to-an-organization[github process]. -pass::[] + diff --git a/tools/logstash-docgen/templates/index-codecs.asciidoc.erb b/tools/logstash-docgen/templates/index-codecs.asciidoc.erb index 3cc116a4b..af0659be0 100644 --- a/tools/logstash-docgen/templates/index-codecs.asciidoc.erb +++ b/tools/logstash-docgen/templates/index-codecs.asciidoc.erb @@ -1,7 +1,7 @@ [[codec-plugins]] == Codec plugins -A codec plugin changes the data representation of an event. Codecs are essentially stream filters that can operate as part +A codec plugin changes the data representation of an event. Codecs are essentially stream filters that can operate as part of an input or output. The following codec plugins are available: @@ -14,8 +14,8 @@ The following codec plugins are available: |======================================================================= <% plugins.each do |plugin| %> -pass::[ ?>] +:edit_url: <%=plugin.edit_url%> include::<%=plugin.type%>/<%=plugin.name%>.asciidoc[] <% end %> -pass::[] +:edit_url: diff --git a/tools/logstash-docgen/templates/index-filters.asciidoc.erb b/tools/logstash-docgen/templates/index-filters.asciidoc.erb index f5e82b253..47340c5c2 100644 --- a/tools/logstash-docgen/templates/index-filters.asciidoc.erb +++ b/tools/logstash-docgen/templates/index-filters.asciidoc.erb @@ -1,7 +1,7 @@ [[filter-plugins]] == Filter plugins -A filter plugin performs intermediary processing on an event. Filters are often applied conditionally depending on the +A filter plugin performs intermediary processing on an event. Filters are often applied conditionally depending on the characteristics of the event. The following filter plugins are available: @@ -14,8 +14,8 @@ The following filter plugins are available: |======================================================================= <% plugins.each do |plugin| %> -pass::[ ?>] +:edit_url: <%=plugin.edit_url%> include::<%=plugin.type%>/<%=plugin.name%>.asciidoc[] <% end %> -pass::[] +:edit_url: diff --git a/tools/logstash-docgen/templates/index-inputs.asciidoc.erb b/tools/logstash-docgen/templates/index-inputs.asciidoc.erb index 20e70ae69..ecc477537 100644 --- a/tools/logstash-docgen/templates/index-inputs.asciidoc.erb +++ b/tools/logstash-docgen/templates/index-inputs.asciidoc.erb @@ -13,8 +13,8 @@ The following input plugins are available: |======================================================================= <% plugins.each do |plugin| %> -pass::[ ?>] +:edit_url: <%=plugin.edit_url%> include::<%=plugin.type%>/<%=plugin.name%>.asciidoc[] <% end %> -pass::[] +:edit_url: diff --git a/tools/logstash-docgen/templates/index-outputs.asciidoc.erb b/tools/logstash-docgen/templates/index-outputs.asciidoc.erb index b64ff8584..6d6d241ba 100644 --- a/tools/logstash-docgen/templates/index-outputs.asciidoc.erb +++ b/tools/logstash-docgen/templates/index-outputs.asciidoc.erb @@ -13,8 +13,8 @@ The following output plugins are available: |======================================================================= <% plugins.each do |plugin| %> -pass::[ ?>] +:edit_url: <%=plugin.edit_url%> include::<%=plugin.type%>/<%=plugin.name%>.asciidoc[] <% end %> -pass::[] +:edit_url: