chore: Brush off markdown files (#12877)

* chore: Remove trailing whitespace from instrumentation.md Signed-off-by: Jesse Szwedko <[email protected]> * Cleanup all lists in markdown files Signed-off-by: Ben Johnson <[email protected]> * More list updates Signed-off-by: Jesse Szwedko <[email protected]> Co-authored-by: Ben Johnson <[email protected]>
vectordotdev · May 26, 2022 · 954a2e5 · 954a2e5
1 parent 4e2a665
commit 954a2e5
Show file tree

Hide file tree

Showing 11 changed files with 329 additions and 379 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,16 +1,11 @@
 # Code of Conduct
 
-<!-- MarkdownTOC autolink="true" style="ordered" indent="   " -->
-
-1. [Our Pledge](#our-pledge)
-1. [Our Standards](#our-standards)
-1. [Our Responsibilities](#our-responsibilities)
-1. [Scope](#scope)
-1. [Enforcement](#enforcement)
-1. [Attribution](#attribution)
-
-<!-- /MarkdownTOC -->
-
+- [Our Pledge](#our-pledge)
+- [Our Standards](#our-standards)
+- [Our Responsibilities](#our-responsibilities)
+- [Scope](#scope)
+- [Enforcement](#enforcement)
+- [Attribution](#attribution)
 
 ## Our Pledge
 
@@ -26,21 +21,21 @@ orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
+- The use of sexualized language or imagery and unwelcome sexual attention or
 advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Our Responsibilities

diff --git a/PRIVACY.md b/PRIVACY.md
@@ -6,17 +6,13 @@ of your most sensitive data, and therefore, Vector strives to be as transparent
 as possible with our privacy efforts. This document clarifies how the Vector
 project thinks about privacy now and in the future.
 
-<!-- MarkdownTOC autolink="true" style="ordered" indent="   " -->
-
-1. [Vector Itself](#vector-itself)
-   1. [Downloads](#downloads)
-   1. [Phoning Home](#phoning-home)
-1. [Vector Website & Docs](#vector-website--docs)
-1. [Vector Community](#vector-community)
-   1. [Vector Repository](#vector-repository)
-   1. [Vector Chat](#vector-chat)
-
-<!-- /MarkdownTOC -->
+- [Vector Itself](#vector-itself)
+  - [Downloads](#downloads)
+  - [Phoning Home](#phoning-home)
+- [Vector Website & Docs](#vector-website--docs)
+- [Vector Community](#vector-community)
+  - [Vector Repository](#vector-repository)
+  - [Vector Chat](#vector-chat)
 
 ## Vector Itself
 

diff --git a/SECURITY.md b/SECURITY.md
@@ -14,50 +14,46 @@ That's why we apply widely accepted best practices when it comes to security.
 This document will describe these practices and aims to be as transparent as
 possible on our security efforts.
 
-<!-- MarkdownTOC autolink="true" style="ordered" indent="   " -->
-
-1. [Project Structure](#project-structure)
-   1. [Transparency](#transparency)
-      1. [Open Source](#open-source)
-      1. [Workflow](#workflow)
-   1. [Version Control](#version-control)
-      1. [Git](#git)
-      1. [Signed Commits](#signed-commits)
-      1. [Protected Branches](#protected-branches)
-1. [Personnel](#personnel)
-   1. [Education](#education)
-   1. [Policies](#policies)
-   1. [Two-factor Authentication](#two-factor-authentication)
-   1. [Privilege Model](#privilege-model)
-   1. [Third-Parties](#third-parties)
-1. [Development & Code](#development--code)
-   1. [Design & Architecture](#design--architecture)
-      1. [Rust](#rust)
-      1. [Unsafe Code](#unsafe-code)
-      1. [User Privileges](#user-privileges)
-   1. [Dependencies](#dependencies)
-   1. [Change Control](#change-control)
-      1. [Pull Requests](#pull-requests)
-      1. [Reviews & Approvals](#reviews--approvals)
-      1. [Merge Policies](#merge-policies)
-   1. [Automated Checks](#automated-checks)
-      1. [Vulnerability Scans & Security Advisories](#vulnerability-scans--security-advisories)
-      1. [Vulnerability Remediation](#vulnerability-remediation)
-      1. [Fuzz Testing](#fuzz-testing)
-1. [Infrastructure](#infrastructure)
-   1. [CI/CD](#cicd)
-      1. [Runtime Isolation](#runtime-isolation)
-   1. [Network Security](#network-security)
-      1. [Penetration Testing](#penetration-testing)
-      1. [Protocols](#protocols)
-   1. [Release Artifacts & Channels](#release-artifacts--channels)
-      1. [Asset Audit Logging](#asset-audit-logging)
-      1. [Asset Signatures & Checksums](#asset-signatures--checksums)
-1. [Meta](#meta)
-   1. [Review Schedule](#review-schedule)
-   1. [Vulnerability Reporting](#vulnerability-reporting)
-
-<!-- /MarkdownTOC -->
+- [Project Structure](#project-structure)
+  - [Transparency](#transparency)
+    - [Open Source](#open-source)
+    - [Workflow](#workflow)
+  - [Version Control](#version-control)
+    - [Git](#git)
+    - [Signed Commits](#signed-commits)
+    - [Protected Branches](#protected-branches)
+- [Personnel](#personnel)
+  - [Education](#education)
+  - [Policies](#policies)
+  - [Two-factor Authentication](#two-factor-authentication)
+  - [Privilege Model](#privilege-model)
+  - [Third-Parties](#third-parties)
+- [Development & Code](#development--code)
+  - [Design & Architecture](#design--architecture)
+    - [Rust](#rust)
+    - [Unsafe Code](#unsafe-code)
+    - [User Privileges](#user-privileges)
+  - [Dependencies](#dependencies)
+  - [Change Control](#change-control)
+    - [Pull Requests](#pull-requests)
+    - [Reviews & Approvals](#reviews--approvals)
+    - [Merge Policies](#merge-policies)
+  - [Automated Checks](#automated-checks)
+    - [Vulnerability Scans & Security Advisories](#vulnerability-scans--security-advisories)
+    - [Vulnerability Remediation](#vulnerability-remediation)
+    - [Fuzz Testing](#fuzz-testing)
+- [Infrastructure](#infrastructure)
+  - [CI/CD](#cicd)
+    - [Runtime Isolation](#runtime-isolation)
+  - [Network Security](#network-security)
+    - [Penetration Testing](#penetration-testing)
+    - [Protocols](#protocols)
+  - [Release Artifacts & Channels](#release-artifacts--channels)
+    - [Asset Audit Logging](#asset-audit-logging)
+    - [Asset Signatures & Checksums](#asset-signatures--checksums)
+- [Meta](#meta)
+  - [Review Schedule](#review-schedule)
+  - [Vulnerability Reporting](#vulnerability-reporting)
 
 ## Project Structure
 

diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -6,34 +6,29 @@ following TOC is sorted progressively, starting with the basics and
 expanding into more specifics. Everyone from a first time contributor to a
 Vector team member will find this document useful.
 
-<!-- MarkdownTOC autolink="true" style="ordered" indent="   " -->
-
-1. [Introduction](#introduction)
-1. [Your First Contribution](#your-first-contribution)
-   1. [New sources, sinks, and transforms](#new-sources-sinks-and-transforms)
-1. [Workflow](#workflow)
-   1. [Git Branches](#git-branches)
-   1. [Git Commits](#git-commits)
-      1. [Style](#style)
-      1. [Signing-off](#signing-off)
-   1. [Github Pull Requests](#github-pull-requests)
-      1. [Title](#title)
-      1. [Reviews & Approvals](#reviews--approvals)
-      1. [Merge Style](#merge-style)
-   1. [CI](#ci)
-      1. [Releasing](#releasing)
-      1. [Testing](#testing)
-         1. [Skipping tests](#skipping-tests)
-         1. [Daily tests](#daily-tests)
-      1. [Flakey tests](#flakey-tests)
-         1. [Test harness](#test-harness)
-   1. [Deprecations](#deprecations)
-1. [Next steps](#next-steps)
-1. [Legal](#legal)
-   1. [CLA](#contributor-license-agreement)
-   1. [Granted rights and copyright assignment](#granted-rights-and-copyright-assignment)
-
-<!-- /MarkdownTOC -->
+- [Introduction](#introduction)
+- [Your First Contribution](#your-first-contribution)
+  - [New sources, sinks, and transforms](#new-sources-sinks-and-transforms)
+- [Workflow](#workflow)
+  - [Git Branches](#git-branches)
+  - [Git Commits](#git-commits)
+    - [Style](#style)
+  - [Github Pull Requests](#github-pull-requests)
+    - [Title](#title)
+    - [Reviews & Approvals](#reviews--approvals)
+    - [Merge Style](#merge-style)
+  - [CI](#ci)
+    - [Releasing](#releasing)
+    - [Testing](#testing)
+      - [Skipping tests](#skipping-tests)
+      - [Daily tests](#daily-tests)
+    - [Flakey tests](#flakey-tests)
+      - [Test harness](#test-harness)
+  - [Deprecations](#deprecations)
+- [Next steps](#next-steps)
+- [Legal](#legal)
+  - [Contributor License Agreement](#contributor-license-agreement)
+  - [Granted rights and copyright assignment](#granted-rights-and-copyright-assignment)
 
 ## Introduction
 

diff --git a/docs/DEVELOPING.md b/docs/DEVELOPING.md
@@ -1,46 +1,39 @@
 # Developing
 
-<!-- MarkdownTOC autolink="true" style="ordered" indent="   " -->
-
-1. [Setup](#setup)
-   1. [Using a Docker or Podman environment](#using-a-docker-or-podman-environment)
-   1. [Bring your own toolbox](#bring-your-own-toolbox)
-1. [The basics](#the-basics)
-   1. [Directory structure](#directory-structure)
-   1. [Makefile](#makefile)
-   1. [Code style](#code-style)
-      1. [Logging style](#logging-style)
-   1. [Feature flags](#feature-flags)
-   1. [Dependencies](#dependencies)
-1. [Guidelines](#guidelines)
-   1. [Sink healthchecks](#sink-healthchecks)
-1. [Testing](#testing)
-   1. [Unit tests](#unit-tests)
-   1. [Integration tests](#integration-tests)
-   1. [Blackbox tests](#blackbox-tests)
-   1. [Tips and tricks](#tips-and-tricks)
-      1. [Faster builds With `sccache`](#faster-builds-with-sccache)
-      1. [Testing specific components](#testing-specific-components)
-      1. [Generating sample logs](#generating-sample-logs)
-1. [Benchmarking](#benchmarking)
-1. [Profiling](#profiling)
-1. [Domains](#domains)
-   1. [Kubernetes](#kubernetes)
-      1. [Architecture](#architecture)
-         1. [The operation logic](#the-operation-logic)
-         1. [Where to find things](#where-to-find-things)
-      1. [Development](#development)
-         1. [Requirements](#requirements)
-         1. [Automatic](#automatic)
-         1. [Manual](#manual)
-         1. [Troubleshooting](#troubleshooting)
-      1. [Testing](#testing-1)
-         1. [Integration tests](#integration-tests-1)
-            1. [Requirements](#requirements-1)
-            1. [Tutorial](#tutorial)
-
-<!-- /MarkdownTOC -->
-
+- [Setup](#setup)
+  - [Using a Docker or Podman environment](#using-a-docker-or-podman-environment)
+  - [Bring your own toolbox](#bring-your-own-toolbox)
+- [The basics](#the-basics)
+  - [Directory structure](#directory-structure)
+  - [Makefile](#makefile)
+  - [Code style](#code-style)
+    - [Logging style](#logging-style)
+  - [Feature flags](#feature-flags)
+  - [Dependencies](#dependencies)
+- [Guidelines](#guidelines)
+  - [Sink healthchecks](#sink-healthchecks)
+- [Testing](#testing)
+  - [Unit tests](#unit-tests)
+  - [Integration tests](#integration-tests)
+  - [Blackbox tests](#blackbox-tests)
+  - [Tips and tricks](#tips-and-tricks)
+    - [Faster builds With `sccache`](#faster-builds-with-sccache)
+    - [Testing specific components](#testing-specific-components)
+    - [Generating sample logs](#generating-sample-logs)
+- [Benchmarking](#benchmarking)
+- [Profiling](#profiling)
+- [Domains](#domains)
+  - [Kubernetes](#kubernetes)
+    - [Architecture](#architecture)
+      - [The operation logic](#the-operation-logic)
+      - [Where to find things](#where-to-find-things)
+    - [Development](#development)
+      - [Requirements](#requirements)
+      - [Automatic](#automatic)
+    - [Testing](#testing-1)
+      - [Integration tests](#integration-tests-1)
+        - [Requirements](#requirements-1)
+        - [Tutorial](#tutorial)
 
 ## Setup
 

diff --git a/docs/REVIEWING.md b/docs/REVIEWING.md
@@ -1,21 +1,17 @@
 # Reviewing
 
-<!-- MarkdownTOC autolink="true" style="ordered" indent="   " -->
-
-1. [Checklist](#checklist)
-1. [Expectations](#expectations)
-1. [Backward Compatibility](#backward-compatibility)
-1. [Code Of Conduct](#code-of-conduct)
-1. [Dependencies](#dependencies)
-1. [Documentation](#documentation)
-1. [Performance Testing](#performance-testing)
-1. [Single Concern](#single-concern)
-1. [Readability](#readability)
-1. [Safe Code](#safe-code)
-1. [Security](#security)
-1. [Testing](#testing)
-
-<!-- /MarkdownTOC -->
+- [Checklist](#checklist)
+- [Expectations](#expectations)
+- [Backward Compatibility](#backward-compatibility)
+- [Code Of Conduct](#code-of-conduct)
+- [Dependencies](#dependencies)
+- [Documentation](#documentation)
+- [Performance Testing](#performance-testing)
+- [Single Concern](#single-concern)
+- [Readability](#readability)
+- [Safe Code](#safe-code)
+- [Security](#security)
+- [Testing](#testing)
 
 ## Checklist