mirror of
https://git.vectorsigma.ru/public/atlantis.git
synced 2026-07-29 00:38:24 +00:00
fix(docs): move TOC to the right nav bar to free up vertical space (#4552)
This commit is contained in:
committed by
GitHub
parent
5fafbb1061
commit
4794bc0a44
@@ -23,6 +23,10 @@ export default defineConfig({
|
|||||||
editLink: {
|
editLink: {
|
||||||
pattern: 'https://github.com/runatlantis/atlantis/edit/main/runatlantis.io/:path'
|
pattern: 'https://github.com/runatlantis/atlantis/edit/main/runatlantis.io/:path'
|
||||||
},
|
},
|
||||||
|
// headline "depth" the right nav will show for its TOC
|
||||||
|
//
|
||||||
|
// https://vitepress.dev/reference/frontmatter-config#outline
|
||||||
|
outline: [2, 3],
|
||||||
search: {
|
search: {
|
||||||
provider: 'algolia',
|
provider: 'algolia',
|
||||||
options: {
|
options: {
|
||||||
|
|||||||
@@ -2,7 +2,6 @@
|
|||||||
This page describes how to create credentials for your Git host (GitHub, GitLab, Gitea, Bitbucket, or Azure DevOps)
|
This page describes how to create credentials for your Git host (GitHub, GitLab, Gitea, Bitbucket, or Azure DevOps)
|
||||||
|
|
||||||
that Atlantis will use to make API calls.
|
that Atlantis will use to make API calls.
|
||||||
[[toc]]
|
|
||||||
|
|
||||||
## Create an Atlantis user (optional)
|
## Create an Atlantis user (optional)
|
||||||
We recommend creating a new user named **@atlantis** (or something close) or using a dedicated CI user.
|
We recommend creating a new user named **@atlantis** (or something close) or using a dedicated CI user.
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
# Command Requirements
|
# Command Requirements
|
||||||
[[toc]]
|
|
||||||
|
|
||||||
## Intro
|
## Intro
|
||||||
Atlantis requires certain conditions be satisfied **before** `atlantis apply` and `atlantis import`
|
Atlantis requires certain conditions be satisfied **before** `atlantis apply` and `atlantis import`
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ Atlantis needs to receive Webhooks from your Git host so that it can respond to
|
|||||||
:::
|
:::
|
||||||
|
|
||||||
See the instructions for your specific provider below.
|
See the instructions for your specific provider below.
|
||||||
[[toc]]
|
|
||||||
|
|
||||||
## GitHub/GitHub Enterprise
|
## GitHub/GitHub Enterprise
|
||||||
You can install your webhook at the [organization](https://docs.github.com/en/get-started/learning-about-github/types-of-github-accounts) level, or for each individual repository.
|
You can install your webhook at the [organization](https://docs.github.com/en/get-started/learning-about-github/types-of-github-accounts) level, or for each individual repository.
|
||||||
|
|||||||
@@ -3,7 +3,6 @@
|
|||||||
Custom workflows can be defined to override the default commands that Atlantis
|
Custom workflows can be defined to override the default commands that Atlantis
|
||||||
runs.
|
runs.
|
||||||
|
|
||||||
[[toc]]
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
Custom workflows can be specified in the Server-Side Repo Config or in the Repo-Level
|
Custom workflows can be specified in the Server-Side Repo Config or in the Repo-Level
|
||||||
|
|||||||
@@ -6,7 +6,6 @@ This page covers getting Atlantis up and running in your infrastructure.
|
|||||||
* You have created a [webhook secret](webhook-secrets.md)
|
* You have created a [webhook secret](webhook-secrets.md)
|
||||||
:::
|
:::
|
||||||
|
|
||||||
[[toc]]
|
|
||||||
|
|
||||||
## Architecture Overview
|
## Architecture Overview
|
||||||
### Runtime
|
### Runtime
|
||||||
|
|||||||
@@ -12,7 +12,6 @@ Which links them to the pull request that holds the lock.
|
|||||||
Only the directory in the repo and Terraform workspace are locked, not the whole repo.
|
Only the directory in the repo and Terraform workspace are locked, not the whole repo.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
[[toc]]
|
|
||||||
|
|
||||||
## Why
|
## Why
|
||||||
1. Because `atlantis apply` is being done before the pull request is merged, after
|
1. Because `atlantis apply` is being done before the pull request is merged, after
|
||||||
|
|||||||
@@ -6,7 +6,6 @@ workflows](custom-workflows.md#custom-run-command) in that they are run
|
|||||||
outside of Atlantis commands. Which means they do not surface their output
|
outside of Atlantis commands. Which means they do not surface their output
|
||||||
back to the PR as a comment.
|
back to the PR as a comment.
|
||||||
|
|
||||||
[[toc]]
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,6 @@ workflows](custom-workflows.md#custom-run-command) in several ways.
|
|||||||
2. Pre workflow hooks are run outside of Atlantis commands. Which means
|
2. Pre workflow hooks are run outside of Atlantis commands. Which means
|
||||||
they do not surface their output back to the PR as a comment.
|
they do not surface their output back to the PR as a comment.
|
||||||
|
|
||||||
[[toc]]
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,6 @@
|
|||||||
An `atlantis.yaml` file specified at the root of a Terraform repo allows you
|
An `atlantis.yaml` file specified at the root of a Terraform repo allows you
|
||||||
to instruct Atlantis on the structure of your repo and set custom workflows.
|
to instruct Atlantis on the structure of your repo and set custom workflows.
|
||||||
|
|
||||||
[[toc]]
|
|
||||||
|
|
||||||
## Do I need an atlantis.yaml file?
|
## Do I need an atlantis.yaml file?
|
||||||
`atlantis.yaml` files are only required if you wish to customize some aspect of Atlantis.
|
`atlantis.yaml` files are only required if you wish to customize some aspect of Atlantis.
|
||||||
|
|||||||
@@ -2,7 +2,6 @@
|
|||||||
Atlantis works with most Git hosts and Terraform setups. Read on to confirm
|
Atlantis works with most Git hosts and Terraform setups. Read on to confirm
|
||||||
it works with yours.
|
it works with yours.
|
||||||
|
|
||||||
[[toc]]
|
|
||||||
|
|
||||||
## Git Host
|
## Git Host
|
||||||
Atlantis integrates with the following Git hosts:
|
Atlantis integrates with the following Git hosts:
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
# Security
|
# Security
|
||||||
[[toc]]
|
|
||||||
## Exploits
|
## Exploits
|
||||||
Because you usually run Atlantis on a server with credentials that allow access to your infrastructure it's important that you deploy Atlantis securely.
|
Because you usually run Atlantis on a server with credentials that allow access to your infrastructure it's important that you deploy Atlantis securely.
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,6 @@ This page explains how to configure the `atlantis server` command.
|
|||||||
Configuration to `atlantis server` can be specified via command line flags,
|
Configuration to `atlantis server` can be specified via command line flags,
|
||||||
environment variables, a config file or a mix of the three.
|
environment variables, a config file or a mix of the three.
|
||||||
|
|
||||||
[[toc]]
|
|
||||||
|
|
||||||
## Environment Variables
|
## Environment Variables
|
||||||
All flags can be specified as environment variables.
|
All flags can be specified as environment variables.
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ A Server-Side Config file is used for more groups of server config that can't re
|
|||||||
One such usecase is to control per-repo behaviour
|
One such usecase is to control per-repo behaviour
|
||||||
and what users can do in repo-level `atlantis.yaml` files.
|
and what users can do in repo-level `atlantis.yaml` files.
|
||||||
|
|
||||||
[[toc]]
|
|
||||||
|
|
||||||
## Do I Need A Server-Side Config File?
|
## Do I Need A Server-Side Config File?
|
||||||
|
|
||||||
|
|||||||
@@ -11,7 +11,6 @@ Atlantis integrates seamlessly with Terraform Cloud and Terraform Enterprise, wh
|
|||||||
* A Private Installation of Terraform Enterprise
|
* A Private Installation of Terraform Enterprise
|
||||||
|
|
||||||
Read the docs below :point_down: depending on your use-case.
|
Read the docs below :point_down: depending on your use-case.
|
||||||
[[toc]]
|
|
||||||
|
|
||||||
## Using Atlantis With Free Remote State Storage
|
## Using Atlantis With Free Remote State Storage
|
||||||
To use Atlantis with Free Remote State Storage, you need to:
|
To use Atlantis with Free Remote State Storage, you need to:
|
||||||
|
|||||||
@@ -14,7 +14,6 @@ You can use following executable names.
|
|||||||
:::
|
:::
|
||||||
|
|
||||||
Currently, Atlantis supports the following commands.
|
Currently, Atlantis supports the following commands.
|
||||||
[[toc]]
|
|
||||||
|
|
||||||
---
|
---
|
||||||
## atlantis help
|
## atlantis help
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ If you want to set up a production-ready Atlantis installation, read [Deployment
|
|||||||
|
|
||||||
Steps:
|
Steps:
|
||||||
|
|
||||||
[[toc]]
|
|
||||||
|
|
||||||
## Install Terraform
|
## Install Terraform
|
||||||
`terraform` needs to be in the `$PATH` for Atlantis.
|
`terraform` needs to be in the `$PATH` for Atlantis.
|
||||||
|
|||||||
Reference in New Issue
Block a user