Terraform provider for ReadMe.com
It uses the ReadMe API Go client and the Terraform Plugin Framework.
This provider is developed by Live Oak Bank and is not affiliated with ReadMe.com.
Terraform 1.0+ is required.
Refer to the provider docs on the Terraform registry for information about using the provider.
provider "readme" {
# Set the API token here or with the README_API_TOKEN env var.
# api_token = ""
}
terraform {
required_providers {
readme = {
source = "liveoaklabs/readme"
version = "~> 0.1"
}
}
}
Create an API specification:
resource "readme_api_specification" "example" {
# 'definition' accepts a string of an OpenAPI specification definition JSON.
definition = file("petstore.json")
}
Create a category:
resource "readme_category" "example" {
title = "My example category"
type = "guide"
}
Create a doc:
resource "readme_doc" "example" {
# title can be specified as an attribute or in the body front matter.
title = "My Example Doc"
# category_slug can be specified as an attribute or in the body front matter.
category_slug = readme_category.example.slug
# hidden can be specified as an attribute or in the body front matter.
hidden = false
# order can be specified as an attribute or in the body front matter.
order = 99
# type can be specified as an attribute or in the body front matter.
type = "basic"
# body can be read from a file using Terraform's `file()` function.
body = file("mydoc.md")
}
Create a version:
resource "readme_version" "example" {
version = "1.1.0"
from = "1.0.0"
is_hidden = true
}
The provider includes several data sources. Refer to the provider docs on the Terraform registry for a full list with examples.
This project uses semantic versioning and is currently in development status using a 0.x.x
versioning scheme.
Breaking changes are likely to occur within the 0.x
minor versions. Once the project reaches 1.0.0
, typical rules
for semantic versioning will apply.
Refer to the CHANGELOG for release details.
Refer to CONTRIBUTING.md
for information on contributing to this project.
This project is licensed under the MIT License - see the LICENSE
file for details.