diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 362cc817..44e9df3e 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -56,5 +56,11 @@ repos: hooks: - id: yamllint + - repo: https://github.com/thlorenz/doctoc + rev: v2.2.0 + hooks: + - id: doctoc + args: [--update-only, --title, "## Table of Contents"] + ci: skip: [golangci-lint-full] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c7f4dfc0..cb7617a8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,20 +3,23 @@ The following is a set of guidelines for contributing to the NGINX AWS Auto-Scale Group Sync tool. We really appreciate that you are considering contributing! -## Table Of Contents - -[Ask a Question](#ask-a-question) - -[Getting Started](#getting-started) - -[Contributing](#contributing) - -[Style Guides](#style-guides) - -- [Git Style Guide](#git-style-guide) -- [Go Style Guide](#go-style-guide) - -[Code of Conduct](CODE_OF_CONDUCT.md) + + +## Table of Contents + +- [Ask a Question](#ask-a-question) +- [Getting Started](#getting-started) + - [Project Structure](#project-structure) +- [Contributing](#contributing) + - [Report a Bug](#report-a-bug) + - [Suggest an Enhancement](#suggest-an-enhancement) + - [Open a Pull Request](#open-a-pull-request) + - [Issue lifecycle](#issue-lifecycle) +- [Style Guides](#style-guides) + - [Git Style Guide](#git-style-guide) + - [Go Style Guide](#go-style-guide) + + ## Ask a Question diff --git a/README.md b/README.md index 397bda95..65b23292 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,27 @@ scaling group of a cloud provider. The following providers are supported: When the number of instances changes, nginx-asg-sync adds the new instances to the NGINX Plus configuration and removes the terminated ones. + + +## Table of Contents + +- [How It Works](#how-it-works) +- [Documentation](#documentation) +- [Supported Operating Systems and Architectures](#supported-operating-systems-and-architectures) +- [Installation](#installation) + - [Manual Installation](#manual-installation) + - [Snap Installation](#snap-installation) + - [NGINX Plus Configuration](#nginx-plus-configuration) + - [Configuration for Cloud Providers](#configuration-for-cloud-providers) +- [Usage](#usage) +- [Troubleshooting](#troubleshooting) +- [Building a Software Package](#building-a-software-package) +- [Contacts](#contacts) +- [Contributing](#contributing) +- [Support](#support) + + + ## How It Works nginx-asg-sync is an agent process that runs on the same instance as NGINX Plus. It polls for changes to the backend @@ -41,25 +62,8 @@ Below you will find documentation on how to use nginx-asg-sync. ## Documentation -> **Note** -> -> The documentation for **the latest stable release** is available via a link in the description of the release. See the -> [releases page](https://github.com/nginxinc/nginx-asg-sync/releases). - -**Contents:** - -- [NGINX Plus Integration with Cloud Autoscaling -- - nginx-asg-sync](#nginx-plus-integration-with-cloud-autoscaling----nginx-asg-sync) - - [How It Works](#how-it-works) - - [Documentation](#documentation) - - [Supported Operating Systems](#supported-operating-systems-and-architectures) - - [Installation](#installation) - - [NGINX Plus Configuration](#nginx-plus-configuration) - - [Configuration for Cloud Providers](#configuration-for-cloud-providers) - - [Usage](#usage) - - [Troubleshooting](#troubleshooting) - - [Building a Software Package](#building-a-software-package) - - [Support](#support) +The documentation for **the latest stable release** is available via a link in the description of the release. See the +[releases page](https://github.com/nginxinc/nginx-asg-sync/releases). ## Supported Operating Systems and Architectures diff --git a/examples/aws.md b/examples/aws.md index aab2d4aa..927d0cde 100644 --- a/examples/aws.md +++ b/examples/aws.md @@ -1,5 +1,14 @@ # Configuration for AWS + + +## Table of Contents + +- [Setting up Access to AWS API](#setting-up-access-to-aws-api) +- [nginx-asg-sync Configuration](#nginx-asg-sync-configuration) + + + ## Setting up Access to AWS API nginx-asg-sync uses the AWS API to get the list of IP addresses of the instances of an Auto Scaling group. To access the diff --git a/examples/azure.md b/examples/azure.md index c3055b77..e15e8c62 100644 --- a/examples/azure.md +++ b/examples/azure.md @@ -1,5 +1,14 @@ # Configuration for Azure + + +## Table of Contents + +- [Setting up Access to Azure API](#setting-up-access-to-azure-api) +- [nginx-asg-sync Configuration](#nginx-asg-sync-configuration) + + + ## Setting up Access to Azure API nginx-asg-sync uses the Azure API to get the list of IP addresses of the instances of a Virtual Machine Scale Set. To diff --git a/tests/README.md b/tests/README.md index 087e770f..e67f7cc9 100644 --- a/tests/README.md +++ b/tests/README.md @@ -8,6 +8,18 @@ Note: for now this is for internal use only, as AWS stack configuration is done Below you will find the instructions on how to run the tests against a cloud provider. + + +## Table of Contents + +- [Running Tests](#running-tests) + - [Prerequisites](#prerequisites) + - [Step 1 - Set up the environment](#step-1---set-up-the-environment) + - [Step 2 - Run the Tests](#step-2---run-the-tests) +- [Configuring the Tests](#configuring-the-tests) + + + ## Running Tests ### Prerequisites