Skip to content

Commit 4e3144c

Browse files
authored
doc: Updates to new Terraform doc structure (#2425)
* move to root doc folder * rename ds and resource folders * change file extension to .md * update doc links * gitignore * releasing instructions * git hook * codeowners * workflow template * gha workflows * scripts * remove website-lint * update references to html.markdown * fix compatibility script matrix * rename rest of files * fix generate doc script using docs-out folder to temporary generate all files and copying only to docs folder the specified resource files * fix typo
1 parent fa31ccf commit 4e3144c

File tree

211 files changed

+56
-91
lines changed

Some content is hidden

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

211 files changed

+56
-91
lines changed

.githooks/pre-commit

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,3 @@ if [ -n "$STAGED_TF_FILES" ]; then
2626
echo "Checking the format of Terraform files"
2727
make tflint
2828
fi
29-
30-
STAGED_WEBSITES_FILES=$(git diff --cached --name-only | grep "website/")
31-
if [ -n "$STAGED_WEBSITES_FILES" ]; then
32-
echo "Checking the format of website files"
33-
make website-lint
34-
fi

.github/CODEOWNERS

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Maintained by the MongoDB APIx-Integrations team
22
* @mongodb/APIx-Integrations
33

4-
54
# Changelog entries reviewed by Docs Cloud Team
65
/.changelog/ @mongodb/docs-cloud-team
7-
/website/ @mongodb/docs-cloud-team
6+
/docs/ @mongodb/docs-cloud-team

.github/ISSUE_TEMPLATE/Bug_Report.md

Lines changed: 1 addition & 1 deletion

.github/workflows/check-migration-guide.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ jobs:
1616
with:
1717
filters: |
1818
guides:
19-
- 'website/docs/guides/**'
19+
- 'docs/guides/**'
2020
- if: ${{ steps.changes.outputs.guides == 'false' }}
2121
run: echo "PR with breaking changes but no migration guide was created or updated" && exit 1

.github/workflows/code-health.yml

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -53,16 +53,6 @@ jobs:
5353
- name: actionlint
5454
run: make tools && actionlint -verbose -color
5555
shell: bash
56-
website-lint:
57-
runs-on: ubuntu-latest
58-
permissions: {}
59-
steps:
60-
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
61-
- uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7
62-
with:
63-
go-version-file: 'go.mod'
64-
- name: website lint
65-
run: make tools && make website-lint
6656
shellcheck:
6757
runs-on: ubuntu-latest
6858
permissions: {}
@@ -71,6 +61,6 @@ jobs:
7161
- name: Run ShellCheck
7262
uses: bewuethr/shellcheck-action@d01912909579c4b1a335828b8fca197fbb8e0aa4
7363
call-acceptance-tests-workflow:
74-
needs: [build, lint, shellcheck, unit-test, website-lint]
64+
needs: [build, lint, shellcheck, unit-test]
7565
secrets: inherit
7666
uses: ./.github/workflows/acceptance-tests.yml

.github/workflows/notify-docs-team.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
filters: |
2121
files:
2222
- '.changelog/**'
23-
- 'website/**'
23+
- 'docs/**'
2424
2525
slack-notification:
2626
needs: check

.github/workflows/release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ jobs:
5757
uses: ./.github/workflows/run-script-and-commit.yml
5858
with:
5959
script_call: './scripts/update-examples-reference-in-docs.sh ${{inputs.version_number}}'
60-
file_to_commit: 'website/docs/index.html.markdown'
61-
commit_message: 'chore: Updates examples link in index.html.markdown for ${{ github.event.inputs.version_number }} release'
60+
file_to_commit: 'docs/index.md'
61+
commit_message: 'chore: Updates examples link in index.md for ${{ github.event.inputs.version_number }} release'
6262
secrets:
6363
apix_bot_pat: ${{ secrets.APIX_BOT_PAT }}
6464
remote: https://svc-apix-bot:${{ secrets.APIX_BOT_PAT }}@github.com/${{ github.repository }}

.gitignore

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,6 @@ terraform.tfstate
99
bin/
1010
modules-dev/
1111
/pkg/
12-
website/.vagrant
13-
website/.bundle
14-
website/build
15-
website/node_modules
1612
.vagrant/
1713
*.backup
1814
./*.tfstate
@@ -34,8 +30,6 @@ __debug_*
3430
coverage.out
3531
simulations
3632

37-
website/vendor
38-
3933
# Test exclusions
4034
!command/test-fixtures/**/*.tfstate
4135
!command/test-fixtures/**/.terraform/

GNUmakefile

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@ lint:
7575
tools: ## Install dev tools
7676
@echo "==> Installing dependencies..."
7777
go install github.com/icholy/gomajor@latest
78-
go install github.com/client9/misspell/cmd/misspell@latest
7978
go install github.com/terraform-linters/[email protected]
8079
go install github.com/rhysd/actionlint/cmd/actionlint@latest
8180
go install golang.org/x/tools/go/analysis/passes/fieldalignment/cmd/fieldalignment@latest
@@ -86,13 +85,8 @@ tools: ## Install dev tools
8685
go install github.com/hashicorp/go-changelog/cmd/changelog-entry@latest
8786
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin $(GOLANGCI_VERSION)
8887

89-
.PHONY: website-lint
90-
website-lint:
91-
@echo "==> Checking website against linters..."
92-
@misspell -error -source=text website/
93-
94-
.PHONY: website
95-
website:
88+
.PHONY: docs
89+
docs:
9690
@echo "Use this site to preview markdown rendering: https://registry.terraform.io/tools/doc-preview"
9791

9892
.PHONY: tflint

README.md

Lines changed: 1 addition & 1 deletion

0 commit comments

Comments
 (0)