Automated Docs PR

.github/actions/copy-cloud-docs-for-tfe/README.md

@@ -0,0 +1,59 @@
+# `copy-cloud-docs-for-tfe`
+
+This composite action is consumed by the `copy-docs.yml` workflow, which is triggered
+at the time of the Terraform Enterprise team's **APP_DEADLINE** event.
+
+Roughly, it behaves as depicted in this diagram:
+
+```mermaid
+graph LR
+    A[terraform-docs-common] -->|copy `/cloud-docs/*` contents<br/>alongside `/enterprise/*` contents| B[ptfe-releases]
+```
+
+## Overview
+
+This action looks for a few things in authored `mdx`, to determine
+if sections or entire pages should be ignored from this copy process.
+
+### Frontmatter
+
+Adding a `tfc_only: true` line in markdown frontmatter signals to
+the action that the associated `.mdx` file should not be handled in the copy process.
+
+#### Example
+
+```markdown
+---
+page_title: Assessments - API Docs - Terraform Cloud
+tfc_only: true
+description: >-
+  Assessment results contain information about continuous validation in
+  Terraform Cloud, like drift detection.
+---
+```
+
+### HTML Comments
+
+Specially formatted HTML comments can be used in matching pairs
+to omit multiple **lines** of text from the copy process.
+
+> **Warning**: This only works with MDX v1.
+
+#### Example
+
+```markdown
+Some content available in both TFC & TFE...
+
+<!-- BEGIN: TFC:only -->
+## Some section
+
+This will only be visible in TFC
+
+<!-- END: TFC:only -->
+
+More content available in both TFC & TFE...
+```
+
+> **Note**: More details are available in this [TFC/TFE Content exclusion][rfc] RFC.
+
+[rfc]: https://docs.google.com/document/d/1DPJU6_7AdGIJVlwJUWBlRqREmYon2IgYf_DrtKjhkcE/edit

.github/actions/copy-cloud-docs-for-tfe/__tests__/__fixtures__/source-template/website/data/cloud-docs-nav-data.json

@@ -0,0 +1 @@
+{}

.github/actions/copy-cloud-docs-for-tfe/__tests__/__fixtures__/source-template/website/docs/cloud-docs/api-docs/index.mdx

@@ -0,0 +1,13 @@
+---
+page_title: API Docs - Terraform Cloud
+description: >-
+  Use the API to manage runs, workspaces, policies, and more. This introduction
+  includes authentication, features, and formatting.
+---
+
+[link to transform]: /terraform/cloud-docs/api-docs
+[agents link do not transform]: /cloud-docs/agents
+[agents link2 do not transform]: /cloud-docs/agents/nested-path
+[agents link3 do not transform]: /terraform/cloud-docs/agents
+[json api document]: /cloud-docs/api-docs#json-api-documents
+[json api error object]: https://jsonapi.org/format/#error-objects

.github/actions/copy-cloud-docs-for-tfe/__tests__/__fixtures__/source-template/website/docs/cloud-docs/api-docs/tfc-only-doc.mdx

@@ -0,0 +1,5 @@
+---
+page_title: This is a TFC-only file
+description:
+tfc_only: true
+---

.github/actions/copy-cloud-docs-for-tfe/__tests__/__fixtures__/source-template/website/docs/cloud-docs/index.mdx

@@ -0,0 +1,16 @@
+---
+page_title: Test Docs
+description: This is a test document
+---
+
+The associated file for this image should be copied
+
+![An Image](/img/docs/image.png)
+
+This link definition should be updated to /enterprise
+
+[json api document]: /cloud-docs/api-docs#json-api-documents
+
+[transform me](/cloud-docs/api-docs/users)
+
+<CustomMdxComponent>Foobar</CustomMdxComponent>

.github/actions/copy-cloud-docs-for-tfe/__tests__/__fixtures__/source-template/website/docs/cloud-docs/registry/index.mdx

@@ -0,0 +1,13 @@
+---
+page_title: Private Registry - Terraform Cloud
+description: >-
+  Use the Terraform Cloud private registry to share Terraform providers and
+  modules across your organization.
+---
+
+# Private Registry
+
+-> **Note:** I am an info alert
+=> **Note:** I am a success alert
+~> **Note:** I am a warning alert
+!> **Note:** I am a warning alert

.github/actions/copy-cloud-docs-for-tfe/__tests__/__fixtures__/source-template/website/docs/cloud-docs/tfc_only.mdx

@@ -0,0 +1,12 @@
+---
+tfc_only: true
+---
+
+This simulates a page that
+
+- was previously copied over to TFE
+  (It will have an entry in `last-cloud-docs-sync.txt`)
+- had `tfc_only: true` added **afterwards**
+
+The expected behavior for this file is that
+it will get pruned on the next copy-docs process.

.github/actions/copy-cloud-docs-for-tfe/__tests__/__fixtures__/target-template/website/data/enterprise-nav-data.json

@@ -0,0 +1 @@
+{}

.github/actions/copy-cloud-docs-for-tfe/__tests__/__fixtures__/target-template/website/docs/enterprise/do-not-remove.mdx

@@ -0,0 +1,7 @@
+---
+page_title: Test Docs
+description: This is a test document
+---
+
+This is previously existing doc in ptfe-releases.
+Ensure this does not get removed

.github/actions/copy-cloud-docs-for-tfe/__tests__/__fixtures__/target-template/website/docs/enterprise/index.mdx

@@ -0,0 +1,10 @@
+---
+page_title: Index
+description: Index
+---
+
+This filename is shared between `cloud-docs/index.mdx` and `enterprise/index.mdx`.
+
+This is a special case where we want to ignore the `cloud-docs` file.
+
+See `IGNORE_LIST` for more details.

.github/actions/copy-cloud-docs-for-tfe/__tests__/__fixtures__/target-template/website/docs/enterprise/stale-cloud-docs/index.mdx

@@ -0,0 +1,8 @@
+---
+page_title: Stale Page
+description: This is a stale cloud-docs document
+---
+
+This represents a stale page, once copied from
+terraform-docs-common, and now intended to be
+pruned.

.github/actions/copy-cloud-docs-for-tfe/__tests__/__fixtures__/target-template/website/last-cloud-docs-sync.txt

@@ -0,0 +1,3 @@
+website/docs/enterprise/stale-cloud-docs/index.mdx
+website/img/docs/_favicon.ico
+website/docs/enterprise/tfc_only.mdx