chore(website): Update Vector description foor guides

Signed-off-by: binarylogic <[email protected]>

README.md

@@ -21,9 +21,10 @@
 
 ## What is Vector?
 
-Vector is a lightweight and ultra-fast tool for building observability
-pipelines. Compared to Logstash and friends, Vector [improves throughput by
-~10X while significanly reducing CPU and memory usage](#performance).
+Vector is a lightweight, ultra-fast, [open-source][urls.vector_repo] tool for
+building observability pipelines. Compared to Logstash and friends, Vector
+[improves throughput by ~10X while significanly reducing CPU and memory
+usage][urls.vector_performance].
 
 ### Principles
 
@@ -271,8 +272,10 @@ Or use your own [preferred method][docs.installation].
 [urls.vector_community]: https://vector.dev/community
 [urls.vector_enriching_transforms]: https://vector.dev/components?functions%5B%5D=enrich
 [urls.vector_parsing_transforms]: https://vector.dev/components?functions%5B%5D=parse
+[urls.vector_performance]: https://vector.dev/#performance
 [urls.vector_privacy_policy]: https://github.com/timberio/vector/blob/master/PRIVACY.md
 [urls.vector_releases]: https://vector.dev/releases/latest
+[urls.vector_repo]: https://github.com/timberio/vector
 [urls.vector_roadmap]: https://github.com/timberio/vector/milestones?direction=asc&sort=due_date&state=open
 [urls.vector_security_policy]: https://github.com/timberio/vector/security/policy
 [urls.vector_test_harness]: https://github.com/timberio/vector-test-harness/

scripts/generate/templates.rb

@@ -44,7 +44,7 @@ def common_component_links(type, limit = 5)
 
     links =
       components.select(&:common?)[0..limit].collect do |component|
-        "[#{component.name}][docs.#{type.to_s.pluralize}.#{component.name}]"
+        "[#{component.name}][#{component_short_link(component)}]"
       end
 
     num_leftover = components.size - links.size
@@ -86,6 +86,10 @@ def component_short_description(component)
     send("#{component.type}_short_description", component)
   end
 
+  def component_short_link(component)
+    "docs.#{component.type.to_s.pluralize}.#{component.name}"
+  end
+
   def components_table(components)
     if !components.is_a?(Array)
       raise ArgumentError.new("Options must be an Array")

scripts/generate/templates/_partials/_component_requirements.md.erb

@@ -2,22 +2,22 @@
 <Alert icon={false} type="danger" classNames="list--warnings">
 
 <%- if component.requirements.aws_imds_v2 %>
-* [AWS IMDS v2][urls.aws_ec2_instance_metadata] is required. This is available by default on
-* Running this transform within Docker on EC2 requires 2 network hops. Users must raise this limit. See ["How it works"](#how-it-works) for more info.
+* [AWS IMDS v2][urls.aws_ec2_instance_metadata] is required. This is available by default on EC2.
+* Running this transform within Docker on EC2 requires 2 network hops. Users must raise this limit. See the ["AWS imDS v2" section][<%= component_short_link(component) %>#aws-imds-v2] for more info.
 <%- end -%>
 <%- if requirements.clickhouse -%>
 * Clickhouse version `<%= requirements.clickhouse %>` is required.
 <%- end -%>
 <%- if requirements.docker_api -%>
 * Docker API `<%= requirements.docker_api %>` is required.
-* In order for the Docker API to work properly, the [`json-file`][urls.docker_logging_driver_json_file] (default) or [`journald`][urls.docker_logging_driver_journald] Docker logging driver must be enabled for this component to work. See ["How it works"](#how-it-works) for more info.
+* In order for the Docker API to work properly, the [`json-file`][urls.docker_logging_driver_json_file] (default) or [`journald`][urls.docker_logging_driver_journald] Docker logging driver must be enabled for this component to work. See the ["Docker Logging Drivers" section][<%= component_short_link(component) %>#docker-logging-drivers] for more info.
 <%- end -%>
 <%- if requirements.file_system -%>
 * This component must be provided access to the configured file system.
 <%- end -%>
 <%- if requirements.journalctl -%>
-* The `journalctl` binary is required, this is the interface Vector uses to retrieve JournalD logs. See ["How it works"](#how-it-works) for more info.
-* The Vector user must be part of the `systemd-journal` group in order to execute the `journalctl` binary. See ["How it works"](#how-it-works) for more info.
+* The `journalctl` binary is required, this is the interface Vector uses to retrieve JournalD logs. See the ["Communication Strategy" section][<%= component_short_link(component) %>#communication-strategy] for more info.
+* The Vector user must be part of the `systemd-journal` group in order to execute the `journalctl` binary. See the ["User Permissions" section][<%= component_short_link(component) %>#user-permissions] for more info.
 <%- end -%>
 <%- if requirements.kafka -%>
 * Kafka version `<%= requirements.kafka %>` is required.

scripts/generate/templates/_partials/_integration_guide.md.erb

@@ -46,10 +46,10 @@ your observability strategy.
 ### How This Guide Works
 
 We'll be using [Vector][urls.vector_website] to accomplish this task. Vector
-is a [popular][urls.vector_stars], lightweight, and
-[ultra-fast][urls.vector_performance] utility for building observability
-pipelines. It's written in [Rust][urls.rust], making it memory safe and
-reliable. We'll be deploying Vector as a
+is a [popular][urls.vector_stars] [open-source][urls.vector_repo] utility for
+building observability pipelines. It's written in [Rust][urls.rust], making it
+lightweight, [ultra-fast][urls.vector_performance] and highly reliable. And
+we'll be deploying Vector as a
 [<%= strategy.name %>][docs.strategies#<%= strategy.name %>].
 
 <%= deployment_strategy(strategy, platform: platform, sink: sink, source: source) %>

scripts/generate/templates/_partials/_vector_summary.md.erb

@@ -1,6 +1,7 @@
-Vector is a lightweight and ultra-fast tool for building observability
-pipelines. Compared to Logstash and friends, Vector [improves throughput by
-~10X while significanly reducing CPU and memory usage](#performance).
+Vector is a lightweight, ultra-fast, [open-source][urls.vector_repo] tool for
+building observability pipelines. Compared to Logstash and friends, Vector
+[improves throughput by ~10X while significanly reducing CPU and memory
+usage][urls.vector_performance].
 
 ### Principles
 

scripts/generate/templates/_partials/deployment_strategies/_daemon.md.erb

@@ -6,7 +6,7 @@ collecting _all_ data for that host.
 For this guide, Vector will <%= source.function_category %> data from
 <%= source.noun %> via Vector's
 [`<%= source.name %>`][docs.sources.<%= source.name %>].
-<% else %>
+<%- else -%>
 Typically data is collected from a process manager, such as Journald via
 Vector's [`journald` source][docs.sources.journald], but can be collected
 through any of Vector's [sources][docs.sources].

website/docs/about/what-is-vector.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-03-31"
+last_modified_on: "2020-04-01"
 title: "What is Vector?"
 description: "High-level description of the Vector observability data collector and router."
 ---
@@ -10,9 +10,10 @@ import SVG from 'react-inlinesvg';
 
 <SVG src="/img/components.svg" />
 
-Vector is a lightweight and ultra-fast tool for building observability
-pipelines. Compared to Logstash and friends, Vector [improves throughput by
-~10X while significanly reducing CPU and memory usage](#performance).
+Vector is a lightweight, ultra-fast, [open-source][urls.vector_repo] tool for
+building observability pipelines. Compared to Logstash and friends, Vector
+[improves throughput by ~10X while significanly reducing CPU and memory
+usage][urls.vector_performance].
 
 ### Principles
 
@@ -45,3 +46,5 @@ pipelines. Compared to Logstash and friends, Vector [improves throughput by
 [docs.strategies#daemon]: /docs/setup/deployment/strategies/#daemon
 [docs.strategies#sidecar]: /docs/setup/deployment/strategies/#sidecar
 [urls.rust]: https://www.rust-lang.org/
+[urls.vector_performance]: https://vector.dev/#performance
+[urls.vector_repo]: https://github.com/timberio/vector

website/docs/reference/sources/docker.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-03-31"
+last_modified_on: "2020-04-01"
 delivery_guarantee: "best_effort"
 component_title: "Docker"
 description: "The Vector `docker` source ingests data through the Docker engine daemon and outputs `log` events."
@@ -38,7 +38,7 @@ daemon][urls.docker_daemon] and [outputs `log` events](#output).
 <Alert icon={false} type="danger" classNames="list--warnings">
 
 * Docker API `>= 1.24` is required.
-* In order for the Docker API to work properly, the [`json-file`][urls.docker_logging_driver_json_file] (default) or [`journald`][urls.docker_logging_driver_journald] Docker logging driver must be enabled for this component to work. See ["How it works"](#how-it-works) for more info.
+* In order for the Docker API to work properly, the [`json-file`][urls.docker_logging_driver_json_file] (default) or [`journald`][urls.docker_logging_driver_journald] Docker logging driver must be enabled for this component to work. See the ["Docker Logging Drivers" section][docs.sources.docker#docker-logging-drivers] for more info.
 
 </Alert>
 
@@ -586,6 +586,7 @@ that we use to determine if an event is partial via the
 
 [docs.configuration#environment-variables]: /docs/setup/configuration/#environment-variables
 [docs.installation.platforms]: /docs/setup/installation/platforms/
+[docs.sources.docker#docker-logging-drivers]: /docs/reference/sources/docker/#docker-logging-drivers
 [docs.sources.journald]: /docs/reference/sources/journald/
 [docs.sources.splunk_hec]: /docs/reference/sources/splunk_hec/
 [docs.sources.syslog]: /docs/reference/sources/syslog/

website/docs/reference/sources/journald.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-03-31"
+last_modified_on: "2020-04-01"
 delivery_guarantee: "at_least_once"
 component_title: "Journald"
 description: "The Vector `journald` source ingests data through Systemd's Journald utility and outputs `log` events."
@@ -37,8 +37,8 @@ utility and [outputs `log` events](#output).
 
 <Alert icon={false} type="danger" classNames="list--warnings">
 
-* The [`journalctl`](#journalctl) binary is required, this is the interface Vector uses to retrieve JournalD logs. See ["How it works"](#how-it-works) for more info.
-* The Vector user must be part of the `systemd-journal` group in order to execute the [`journalctl`](#journalctl) binary. See ["How it works"](#how-it-works) for more info.
+* The [`journalctl`](#journalctl) binary is required, this is the interface Vector uses to retrieve JournalD logs. See the ["Communication Strategy" section][docs.sources.journald#communication-strategy] for more info.
+* The Vector user must be part of the `systemd-journal` group in order to execute the [`journalctl`](#journalctl) binary. See the ["User Permissions" section][docs.sources.journald#user-permissions] for more info.
 
 </Alert>
 
@@ -438,6 +438,8 @@ usermod -aG systemd-journal vector
 
 [docs.configuration#environment-variables]: /docs/setup/configuration/#environment-variables
 [docs.global-options#data_dir]: /docs/reference/global-options/#data_dir
+[docs.sources.journald#communication-strategy]: /docs/reference/sources/journald/#communication-strategy
+[docs.sources.journald#user-permissions]: /docs/reference/sources/journald/#user-permissions
 [urls.issue_1473]: https://github.com/timberio/vector/issues/1473
 [urls.journald]: https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html
 [urls.rust_subprocess]: https://docs.rs/subprocess

website/docs/reference/transforms/aws_ec2_metadata.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-03-31"
+last_modified_on: "2020-04-01"
 component_title: "AWS EC2 Metadata"
 description: "The Vector `aws_ec2_metadata` transform accepts and outputs `log` events allowing you to enrich logs with AWS EC2 instance metadata."
 event_types: ["log"]
@@ -33,8 +33,8 @@ AWS EC2 instance metadata.
 <Alert icon={false} type="danger" classNames="list--warnings">
 
 
-* [AWS IMDS v2][urls.aws_ec2_instance_metadata] is required. This is available by default on
-* Running this transform within Docker on EC2 requires 2 network hops. Users must raise this limit. See ["How it works"](#how-it-works) for more info.
+* [AWS IMDS v2][urls.aws_ec2_instance_metadata] is required. This is available by default on EC2.
+* Running this transform within Docker on EC2 requires 2 network hops. Users must raise this limit. See the ["AWS imDS v2" section][docs.transforms.aws_ec2_metadata#aws-imds-v2] for more info.
 
 </Alert>
 
@@ -495,6 +495,7 @@ You can learn more in the
 
 
 [docs.configuration#environment-variables]: /docs/setup/configuration/#environment-variables
+[docs.transforms.aws_ec2_metadata#aws-imds-v2]: /docs/reference/transforms/aws_ec2_metadata/#aws-imds-v2
 [urls.aws_ec2_instance_metadata]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
 [urls.aws_imds_v1_security_problems]: https://aws.amazon.com/blogs/security/defense-in-depth-open-firewalls-reverse-proxies-ssrf-vulnerabilities-ec2-instance-metadata-service/
 [urls.vector_programmable_transforms]: https://vector.dev/components?functions%5B%5D=program

website/docs/setup/deployment/strategies.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-03-31"
+last_modified_on: "2020-04-01"
 title: Deployment Strategies
 description: The various strategies used to deploy Vector across your infrastructure.
 sidebar_label: Strategies
@@ -30,7 +30,6 @@ detail and help you understand when to use each.
 The [daemon deployment strategy][docs.strategies#daemon] is designed for data
 collection on a single host. Vector runs in the background, in its own process,
 collecting _all_ data for that host.
-
 Typically data is collected from a process manager, such as Journald via
 Vector's [`journald` source][docs.sources.journald], but can be collected
 through any of Vector's [sources][docs.sources].

website/docs/setup/installation/operating-systems/amazon-linux.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-03-31"
+last_modified_on: "2020-04-01"
 title: Install Vector On Amazon Linux
 sidebar_label: Amazon Linux
 description: Install Vector on Amazon Linux
@@ -36,7 +36,6 @@ will cover how to install Vector on this operating system.
 The [daemon deployment strategy][docs.strategies#daemon] is designed for data
 collection on a single host. Vector runs in the background, in its own process,
 collecting _all_ data for that host.
-
 Typically data is collected from a process manager, such as Journald via
 Vector's [`journald` source][docs.sources.journald], but can be collected
 through any of Vector's [sources][docs.sources].

website/docs/setup/installation/operating-systems/centos.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-03-31"
+last_modified_on: "2020-04-01"
 title: Install Vector On CentOS
 sidebar_label: CentOS
 description: Install Vector on CentOS
@@ -35,7 +35,6 @@ This document will cover installing Vector on CentOS.
 The [daemon deployment strategy][docs.strategies#daemon] is designed for data
 collection on a single host. Vector runs in the background, in its own process,
 collecting _all_ data for that host.
-
 Typically data is collected from a process manager, such as Journald via
 Vector's [`journald` source][docs.sources.journald], but can be collected
 through any of Vector's [sources][docs.sources].

website/docs/setup/installation/operating-systems/debian.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-03-31"
+last_modified_on: "2020-04-01"
 title: Install Vector On Debian
 sidebar_label: Debian
 description: Install Vector on the Debian operating system
@@ -35,7 +35,6 @@ This document will cover installing Vector on Debian.
 The [daemon deployment strategy][docs.strategies#daemon] is designed for data
 collection on a single host. Vector runs in the background, in its own process,
 collecting _all_ data for that host.
-
 Typically data is collected from a process manager, such as Journald via
 Vector's [`journald` source][docs.sources.journald], but can be collected
 through any of Vector's [sources][docs.sources].

website/docs/setup/installation/operating-systems/macos.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-03-31"
+last_modified_on: "2020-04-01"
 title: Install Vector On MacOS
 sidebar_label: MacOS
 description: Install Vector on MacOS
@@ -35,7 +35,6 @@ This document will cover installing Vector on MacOS.
 The [daemon deployment strategy][docs.strategies#daemon] is designed for data
 collection on a single host. Vector runs in the background, in its own process,
 collecting _all_ data for that host.
-
 Typically data is collected from a process manager, such as Journald via
 Vector's [`journald` source][docs.sources.journald], but can be collected
 through any of Vector's [sources][docs.sources].

website/docs/setup/installation/operating-systems/nixos.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-03-31"
+last_modified_on: "2020-04-01"
 title: Install Vector On NixOS
 sidebar_label: NixOS
 description: Install Vector on NixOS
@@ -35,7 +35,6 @@ This document will cover installing Vector on NixOS.
 The [daemon deployment strategy][docs.strategies#daemon] is designed for data
 collection on a single host. Vector runs in the background, in its own process,
 collecting _all_ data for that host.
-
 Typically data is collected from a process manager, such as Journald via
 Vector's [`journald` source][docs.sources.journald], but can be collected
 through any of Vector's [sources][docs.sources].

website/docs/setup/installation/operating-systems/raspbian.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-03-31"
+last_modified_on: "2020-04-01"
 title: Install Vector On Raspbian
 sidebar_label: Raspbian
 description: Install Vector On Raspbian
@@ -34,7 +34,6 @@ This document will cover installing Vector on Raspbian.
 The [daemon deployment strategy][docs.strategies#daemon] is designed for data
 collection on a single host. Vector runs in the background, in its own process,
 collecting _all_ data for that host.
-
 Typically data is collected from a process manager, such as Journald via
 Vector's [`journald` source][docs.sources.journald], but can be collected
 through any of Vector's [sources][docs.sources].

website/docs/setup/installation/operating-systems/rhel.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-03-31"
+last_modified_on: "2020-04-01"
 title: Install Vector On Red Hat Enterprise Linux
 sidebar_label: RHEL
 description: Install Vector on Red Hat Enterprise Linux
@@ -35,7 +35,6 @@ This document will cover installing Vector on Red Hat Enterprise Linux.
 The [daemon deployment strategy][docs.strategies#daemon] is designed for data
 collection on a single host. Vector runs in the background, in its own process,
 collecting _all_ data for that host.
-
 Typically data is collected from a process manager, such as Journald via
 Vector's [`journald` source][docs.sources.journald], but can be collected
 through any of Vector's [sources][docs.sources].

website/docs/setup/installation/operating-systems/ubuntu.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-03-31"
+last_modified_on: "2020-04-01"
 title: Install Vector On Ubuntu
 sidebar_label: Ubuntu
 description: Install Vector on the Ubuntu operating system
@@ -35,7 +35,6 @@ This document will cover installing Vector on Ubuntu.
 The [daemon deployment strategy][docs.strategies#daemon] is designed for data
 collection on a single host. Vector runs in the background, in its own process,
 collecting _all_ data for that host.
-
 Typically data is collected from a process manager, such as Journald via
 Vector's [`journald` source][docs.sources.journald], but can be collected
 through any of Vector's [sources][docs.sources].

website/docs/setup/installation/operating-systems/windows.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-03-31"
+last_modified_on: "2020-04-01"
 title: Install Vector On Windows
 sidebar_label: Windows
 description: Install Vector on Windows
@@ -35,7 +35,6 @@ This document will cover installing Vector on Windows.
 The [daemon deployment strategy][docs.strategies#daemon] is designed for data
 collection on a single host. Vector runs in the background, in its own process,
 collecting _all_ data for that host.
-
 Typically data is collected from a process manager, such as Journald via
 Vector's [`journald` source][docs.sources.journald], but can be collected
 through any of Vector's [sources][docs.sources].

website/docs/setup/installation/package-managers/dpkg.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-03-31"
+last_modified_on: "2020-04-01"
 title: Install Vector via DPKG
 sidebar_label: DPKG
 description: Install Vector through the DKG package manager
@@ -35,7 +35,6 @@ generally used on Debian and Ubuntu systems.
 The [daemon deployment strategy][docs.strategies#daemon] is designed for data
 collection on a single host. Vector runs in the background, in its own process,
 collecting _all_ data for that host.
-
 Typically data is collected from a process manager, such as Journald via
 Vector's [`journald` source][docs.sources.journald], but can be collected
 through any of Vector's [sources][docs.sources].