mirror/ascode
1
1
Fork 0
mirror of https://github.com/mcuadros/ascode synced 2024-11-22 17:02:03 +01:00
Code Issues

documentation: fix some typos and whitespace

Browse Source
This commit is contained in:
Javi Fontan 2020-03-29 22:07:15 +02:00
parent b6b3d7da9f
commit ca69c208d3
No known key found for this signature in database
GPG Key ID: CC378C088E01FF94
4 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
_documentation/_index.md
View File

@ -13,4 +13,4 @@ Terraform is a great tool, with support for almost everything you can imagine, m
### What is Starlark? ### What is Starlark?
Starlark is a dialect of Python intended for use as a configuration language. A Starlark interpreter is typically embedded within a larger application, and this application may define additional domain-specific functions and data types beyond those provided by the core language. For example, Starlark is embedded within (and was originally developed for) the Bazel build tool, and Bazel's build language is based on Starlark. Starlark is a dialect of Python intended to be used as a configuration language. A Starlark interpreter is typically embedded within a larger application, and this application may define additional domain-specific functions and data types beyond those provided by the core language. For example, Starlark is embedded within (and was originally developed for) the Bazel build tool, and Bazel's build language is based on Starlark.

10
_documentation/getting-started.md
View File

@ -3,7 +3,7 @@ title: 'Getting Started'
weight: 2 weight: 2
--- ---
This page explains the basics of using AsCode to define your infrastructure in Terraform. It assumes that you have already [installed](/docs/install) Ascode. This page explains the basics of using AsCode to define your infrastructure in Terraform. It assumes that you have already [installed](/docs/install) AsCode.
```sh ```sh
> ascode --help > ascode --help
@ -49,16 +49,16 @@ resource "aws_instance" "web" {
The `run` command executes a valid Starlack program. Using the `--print-hcl` and `--to-hcl`, an HCL encoded version of the `tf` object will be printed or saved to a given file, respectively. The `run` command executes a valid Starlack program. Using the `--print-hcl` and `--to-hcl`, an HCL encoded version of the `tf` object will be printed or saved to a given file, respectively.
This is the first step to deploy any infrastructure d defined with AsCode, using `run` and generating a valid `.tf` file, we can use the standard Terraform tooling to deploy our infrastructure using `terraform init`, `terraform plan` and `terraform apply`. This is the first step to deploy any infrastructure defined with AsCode, using `run` and generating a valid `.tf` file, we can use the standard Terraform tooling to deploy our infrastructure using `terraform init`, `terraform plan` and `terraform apply`.
To learn about writing Starlark programs, please refer to the [Language definition](/docs/starlark/) and the [API Reference](/docs/reference/) sections of this documentation. To learn about writing Starlark programs, please refer to the [Language definition](/docs/starlark/) and the [API Reference](/docs/reference/) sections of this documentation.
### Basic Example ### Basic Example
The goal of the example is create, in DigitalOcean, one `s-1vcpu-1gb` instance called `web` in the `nyc2` region: The goal of the example is to create, in DigitalOcean, one `s-1vcpu-1gb` instance called `web` in the `nyc2` region:
> For running this example, you need `terraform` correctly installed on your system. > To run this example, you need `terraform` correctly installed on your system.
```sh ```sh
> mkdir example; cd example > mkdir example; cd example
@ -89,7 +89,7 @@ resource "digitalocean_droplet" "web" {
``` ```
And now as it's common in terraform we can run `init`, `plan` or/and `apply` And now as it's usual in terraform we can run `init`, `plan` or/and `apply`
```sh ```sh
> terraform init > terraform init

2
_documentation/github-action.md
View File

@ -3,7 +3,7 @@ title: 'GitHub Action'
weight: 40 weight: 40
--- ---
AsCode Github Action allows to execute AsCode `run` command in response to a GitHub event such as updating a pull request or pushing a new commit on a specific branch. AsCode Github Action allows to execute AsCode `run` command in response to a GitHub event such as updating a pull request or pushing a new commit to a specific branch.
This used in combination with the [Terraform GitHub Actions](https://www.terraform.io/docs/github-actions/getting-started.html) allows to execute the different terraform commands `init`, `plan` and `apply` inside of a [GitHub Workflow](https://help.github.com/en/actions/configuring-and-managing-workflows). This used in combination with the [Terraform GitHub Actions](https://www.terraform.io/docs/github-actions/getting-started.html) allows to execute the different terraform commands `init`, `plan` and `apply` inside of a [GitHub Workflow](https://help.github.com/en/actions/configuring-and-managing-workflows).

2
_documentation/install.md
View File

@ -40,7 +40,7 @@ mv ascode /usr/local/bin/
### Clone from GitHub ### Clone from GitHub
AsCode uses the [Go Modules](https://github.com/golang/go/wiki/Modules), so e easiest way to get started is to clone AsCode in a directory outside of the `$GOPATH`, as in the following example: AsCode uses the [Go Modules](https://github.com/golang/go/wiki/Modules), so the easiest way to get started is to clone AsCode in a directory outside of the `$GOPATH`, as in the following example:
```sh ```sh
git clone https://github.com/mcuadros/ascode.git $HOME/ascode-src git clone https://github.com/mcuadros/ascode.git $HOME/ascode-src