diff --git a/website/Makefile b/website/Makefile index fe76940c45..7b81de27f4 100644 --- a/website/Makefile +++ b/website/Makefile @@ -1,13 +1,8 @@ -###################################################### -# NOTE: This file is managed by the Digital Team's # -# Terraform configuration @ hashicorp/mktg-terraform # -###################################################### - .DEFAULT_GOAL := website # Set the preview mode for the website shell to "developer" or "io" PREVIEW_MODE ?= developer -REPO ?= terraform +REPO ?= opentf # Enable setting alternate docker tool, e.g. 'make DOCKER_CMD=podman' DOCKER_CMD ?= docker diff --git a/website/README.md b/website/README.md index 35a2758e29..15d8401bbd 100644 --- a/website/README.md +++ b/website/README.md @@ -1,15 +1,12 @@ -# Terraform Documentation +# OpenTF Documentation -This directory contains the portions of [the Terraform website](https://www.placeholderplaceholderplaceholder.io/) that pertain to the core functionality, excluding providers and the overall configuration. - -The website uses the files in this directory in conjunction with -[the `terraform-website` repository](https://github.com/hashicorp/terraform-website). The `terraform-website` repository brings all of the documentation together and contains the scripts for testing and building the entire site. +This directory contains the portions of [the OpenTF website](https://placeholderplaceholderplaceholder.io/) that pertain to the core functionality, excluding providers and the overall configuration. ## Suggesting Changes -You can [submit an issue](https://github.com/placeholderplaceholderplaceholder/opentf/issues/new/choose) with documentation requests or submit a pull request with suggested changes. +You can [submit an issue](https://github.com/opentffoundation/opentf/issues/new/choose) with documentation requests or submit a pull request with suggested changes. -Click **Edit this page** at the bottom of any Terraform website page to go directly to the associated markdown file in GitHub. +Click **Edit this page** at the bottom of any OpenTF website page to go directly to the associated markdown file in GitHub. ## Validating Content @@ -27,19 +24,13 @@ You must update the the sidebar navigation when you add or delete documentation To update the sidebar navigation, you must edit the appropriate `nav-data.json` file. This repository contains the sidebar navigation files for the following documentation sets: -- Terraform Language: [`language-nav-data.json`](https://github.com/placeholderplaceholderplaceholder/opentf/blob/main/website/data/language-nav-data.json) -- Terraform CLI: [`cli-nav-data.json`](https://github.com/placeholderplaceholderplaceholder/opentf/blob/main/website/data/cli-nav-data.json) -- Introduction to Terraform: [`intro-nav-data.json`](https://github.com/placeholderplaceholderplaceholder/opentf/blob/update-readme/website/data/intro-nav-data.json) - -For more details about how to update the sidebar navigation, refer to [Editing Navigation Sidebars](https://github.com/hashicorp/terraform-website#editing-navigation-sidebars) in the `terraform-website` repository. - -## Adding Redirects - -You must add a redirect when you move, rename, or delete documentation pages. Refer to https://github.com/hashicorp/terraform-website#redirects for details. +- OpenTF Language: [`language-nav-data.json`](https://github.com/opentffoundation/opentf/blob/main/website/data/language-nav-data.json) +- OpenTF CLI: [`cli-nav-data.json`](https://github.com/opentffoundation/opentf/blob/main/website/data/cli-nav-data.json) +- Introduction to OpenTF: [`intro-nav-data.json`](https://github.com/opentffoundation/opentf/blob/main/website/data/intro-nav-data.json) ## Previewing Changes -You should preview all of your changes locally before creating a pull request. The build includes content from this repository and the [`terraform-website`](https://github.com/hashicorp/terraform-website/) repository, allowing you to preview the entire Terraform documentation site. +You should preview all of your changes locally before creating a pull request. **Set Up Local Environment** @@ -79,8 +70,6 @@ To make your changes available on the latest docs version: 1. Merge the pull request. GitHub Actions autogenerates a backport pull request, linked to the original. - Screen Shot 2022-08-09 at 11 08 52 AM - 1. Merge the auto-generated backport pull request. You can review and merge your own backport pull request without waiting for another review if the changes in the backport pull request are effectively equivalent to the original. You can make minor adjustments to resolve merge conflicts, but you should not merge a backport PR that contains major content or functionality changes from the original, approved pull request. If you are not sure whether it is okay to merge a backport pull request, post a comment on the original pull request to discuss with the team. diff --git a/website/package-lock.json b/website/package-lock.json index 6d554188f2..943ae5bfb0 100644 --- a/website/package-lock.json +++ b/website/package-lock.json @@ -1,10 +1,10 @@ { - "name": "terraform-docs-preview", + "name": "opentf-docs-preview", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "terraform-docs-preview", + "name": "opentf-docs-preview", "devDependencies": { "@hashicorp/platform-cli": "^2.6.0", "@hashicorp/platform-content-conformance": "^0.0.10", diff --git a/website/package.json b/website/package.json index eb63c5744f..4757e65b46 100644 --- a/website/package.json +++ b/website/package.json @@ -1,5 +1,5 @@ { - "name": "terraform-docs-preview", + "name": "opentf-docs-preview", "private": "true", "scripts": { "build": "./scripts/website-build.sh",