Skip to content

Commit a36c83b

Browse files
authored
chore(docs): remove documentation that has been moved to hashicorp/web-unified-docs
Back in May, all the contents of the website/ directory which powers our documentation on developer.hashicorp.com were migrated to the centralized hashicorp/web-unified-docs repository. At the time, we left the docs here just in case something happened and we needed to revert the migration. Now that a couple of months have passed, we can confirm the migration was completed successfully and there's no reason to revert it, so it's time to completely delete all the contents of the old website/ directory, which can be a potential source of confusion for users.
1 parent c7c1144 commit a36c83b

File tree

117 files changed

+21
-215026
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+21
-215026
lines changed

.github/CODEOWNERS

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,5 @@
1-
# We use this for automatic PR review assignment within Github.
2-
# If individual users are specified in this file, this is mainly to
3-
# inform them of certain PRs and we don't require a review from them
4-
# to be able to merge PRs.
5-
61
# These owners will be the default owners for everything in
72
# the repo. Unless a later match takes precedence,
83
# they will be requested for review when someone opens a
94
# pull request.
105
* @hashicorp/cdktf
11-
12-
# Engineering and web presence get notified of, and can approve changes to web tooling, but not content.
13-
14-
/website/ @hashicorp/web-presence @hashicorp/cdktf
15-
/website/data/
16-
/website/public/
17-
/website/content/
18-
19-
# Education and engineering get notified of, and can approve changes to web content.
20-
21-
/website/data/ @hashicorp/team-docs-packer-and-terraform @hashicorp/cdktf
22-
/website/public/ @hashicorp/team-docs-packer-and-terraform @hashicorp/cdktf
23-
/website/content/ @hashicorp/team-docs-packer-and-terraform @hashicorp/cdktf
24-
/website/docs/ @hashicorp/team-docs-packer-and-terraform @hashicorp/cdktf
25-
/website/README.md @hashicorp/team-docs-packer-and-terraform @hashicorp/cdktf
26-
27-
# No codeowners for these files, as they are generated.
28-
# This way, Education does not get notified if only these files changed.
29-
website/docs/cdktf/api-reference/typescript.mdx
30-
website/docs/cdktf/api-reference/python.mdx
31-
website/docs/cdktf/api-reference/java.mdx
32-
website/docs/cdktf/api-reference/csharp.mdx
33-
website/docs/cdktf/api-reference/go.mdx

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33

44
blank_issues_enabled: false
55
contact_links:
6+
- name: 📕 Documentation Issue
7+
url: https://github.com/hashicorp/web-unified-docs
8+
about: Documentation has its own repository for all HashiCorp products and related issues or questions should be directed there
69
- name: ❓ Question
710
url: https://discuss.hashicorp.com/c/terraform-core/cdk-for-terraform/47
811
about: 🙋 For usage questions that may not require a core maintainer to answer, post in our community forum

.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 0 additions & 59 deletions
This file was deleted.

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ In plain English, describe your approach to addressing the issue linked above. F
2020
- [ ] I have run the linter on my code locally
2121
- [ ] I have performed a self-review of my code
2222
- [ ] I have commented my code, particularly in hard-to-understand areas
23-
- [ ] I have made corresponding changes to the documentation if applicable
23+
- [ ] I have made corresponding changes to the [documentation](https://github.com/hashicorp/web-unified-docs/tree/main/content/terraform-cdk) if applicable
2424
- [ ] My changes generate no new warnings
2525
- [ ] I have added tests that prove my fix is effective or that my feature works if applicable
2626
- [ ] New and existing unit tests pass locally with my changes

.github/workflows/check-legacy-links-format.yml

Lines changed: 0 additions & 17 deletions
This file was deleted.

.github/workflows/website-release.yml

Lines changed: 0 additions & 31 deletions
This file was deleted.

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ node_modules
1313
.cdk.staging
1414
cdktf.out
1515

16-
1716
**/.DS_Store
1817
**/.gen
1918
**/*.log
@@ -41,3 +40,6 @@ examples/java/gradle-shared-module/.gradle/
4140
.nx/
4241
.yarn
4342
test/.yarn
43+
44+
website/*
45+
!website/README.md

.prettierignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,9 @@ test/edge-provider-bindings
1717
!tools/update-github-project-board/index.ts
1818
**/go.mod
1919
**/go.sum
20-
website/website-preview
2120
*.py
2221
*.java
2322
*.go
2423
*.cs
2524
packages/cdktf-cli/src/lib/ambient.d.ts
2625
packages/cdktf-cli/ambient.d.ts
27-

CONTRIBUTING.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Ensuring your PR titles follow this format helps us quickly identify the purpose
8989

9090
To build and install `terraform-cdk` locally you need to install:
9191

92-
- Node version 14.0+
92+
- Node version 20.0+
9393
- Go 1.18
9494
- dotnet (v6.0)
9595
- mvn
@@ -365,14 +365,17 @@ Most of our tests are automated but there are some workflows we need to manually
365365
1. Create a new branch (e.g. `prepare-release-0.9.0`)
366366
2. Update the [CHANGELOG](./CHANGELOG.md): `./tools/create-changelog.sh` should get you a good start
367367
3. Update the version in the root `package.json`
368-
4. Write an [upgrade guide](website/docs/cdktf/release/) (for major releases)
369-
5. Run `yarn generate-docs` to bring our api documentation up to date
370-
6. Create a PR to merge the new branch into `main`
371-
7. Merge the PR, a new release will be build and published because the version changed
368+
4. Create a PR to merge the new branch into `main`
369+
5. Merge the PR, a new release will be build and published because the version changed
370+
6. For major releases:
371+
372+
- Write an [upgrade guide](https://github.com/hashicorp/web-unified-docs/tree/main/content/terraform-cdk/v0.21.x/docs/cdktf/release)
373+
- Run `yarn generate-docs` to bring our api documentation up to date
374+
- Make a PR with the changes over in the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository
372375

373376
#### After the release
374377

375-
- Update the prebuilt provider repository [like this](https://github.com/hashicorp/cdktf-repository-manager/pull/48) (If the release contains breaking changes the commit message needs to have a `!` after the scope so that the minor version is bumped. Example: `chore!: update cdktf version`) and run the [prebuilt provider upgrade workflow](https://github.com/hashicorp/cdktf-repository-manager/actions/workflows/upgrade-repositories.yml)
378+
- Updates in our other repos should largely be automated, but some of the updates require manual approval before they'll be auto-merged
376379
- Update the learn examples and the end to end examples
377380
- Check if there are PRs left behind on our [triage board](https://github.com/orgs/hashicorp/projects/125/views/4)
378381

@@ -473,4 +476,4 @@ A good way to tackle windows related things is to use an AWS EC2 instance runnin
473476

474477
## Documentation
475478

476-
The markdown files containing the documentation for CDK for Terraform are in the [`/website`](./website) directory. Refer to the [website README](./website/README.md) for more information.
479+
Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to the [`terraform-cdk`](https://github.com/hashicorp/web-unified-docs/tree/main/content/terraform-cdk) directory under `web-unified-docs`, since changes to `/website` in this repository will not appear on [developer.hashicorp.com](https://developer.hashicorp.com).

Makefile

Lines changed: 0 additions & 16 deletions
This file was deleted.

0 commit comments

Comments
 (0)