Skip to content

Move legacy terraform provider docs to its own section #34141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 4 commits into
base: docs-upcoming-v26.0.0
Choose a base branch
from
Open

Move legacy terraform provider docs to its own section #34141

wants to merge 4 commits into from

Conversation

@SangJunBak
Copy link
Contributor

@SangJunBak SangJunBak commented Nov 14, 2025

Motivation

Fixes https://materializeinc.slack.com/archives/C07PN7KSB0T/p1763064745670359

Tips for reviewer

Checklist

  • This PR has adequate test coverage / QA involvement has been duly considered. (trigger-ci for additional test/nightly runs)
  • This PR has an associated up-to-date design doc, is a design doc (template), or is sufficiently small to not require a design.
  • If this PR evolves an existing $T ⇔ Proto$T mapping (possibly in a backwards-incompatible way), then it is tagged with a T-proto label.
  • If this PR will require changes to cloud orchestration or tests, there is a companion cloud PR to account for those changes that is tagged with the release-blocker label (example).
  • If this PR includes major user-facing behavior changes, I have pinged the relevant PM to schedule a changelog post.

@SangJunBak SangJunBak requested a review from a team as a code owner November 14, 2025 22:06
@SangJunBak SangJunBak requested a review from kay-kim November 14, 2025 22:06
@SangJunBak SangJunBak marked this pull request as draft November 14, 2025 22:06
@SangJunBak SangJunBak force-pushed the jun/move-terraform-docs branch from df2525e to 2f3b1e3 Compare November 14, 2025 22:07
@SangJunBak SangJunBak marked this pull request as ready for review November 14, 2025 22:09
@SangJunBak
docs: Relabel GCP guides as legacy Terraform guides
9354265 
- Moves the install, upgrade, and configuration docs into a subdirectory called Terraform Provider (Legacy)
- Creates aliases for each of the moved pages
- `Installation > Install on GCP `-> `Installation > Install on GCP > Terraform Provider (Legacy) > Install`
- Removed terraform references from the Deployment guideline appendix and pushed them into the Configuration appendix
- Changed from "Required configuration" to just "configuration"
@SangJunBak
docs: Relabel AWS guides as legacy Terraform guides
52a21a7 
- Does the same work as the GCP commit
@SangJunBak
docs: Relabel Azure guides as legacy Terraform guides
e267e2a 
- Does the same thing as the GCP commit
- Removes terraform configuation values given they weren't rendered. e.g. enable_disk_support
@SangJunBak
Update doc links
034d7b9
@SangJunBak SangJunBak force-pushed the jun/move-terraform-docs branch from 0b36700 to 034d7b9 Compare November 14, 2025 22:31
@jubrad
Copy link
Contributor

jubrad commented Nov 15, 2025

This looks good! Pretty much what we discussed, but I'll leave it to Kay to review.

I do think we need to make sure we have a good idea of what should go on the cloud specific index.md files.. should it be the new terraform or should that have a section just like legacy? If the new TF has its own section (my preference) then we should provide some top level descriptions of how MZ works on that cloud, what is supported in general, and what deployment options are available (right now just TF).

kay-kim
kay-kim reviewed Nov 17, 2025
View reviewed changes
Copy link
Contributor

@kay-kim kay-kim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the changes seem good as well. But, FYI, this won't be mergeable until we have the instructions for the new Terraforms.

@jubrad
Copy link
Contributor

jubrad commented Nov 17, 2025

So the changes seem good as well. But, FYI, this won't be mergeable until we have the instructions for the new Terraforms.
hmmm, I'll rebase the changes for the new terraform I'm working on to be against this.

@jubrad jubrad mentioned this pull request Nov 18, 2025
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kay-kim kay-kim kay-kim left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@SangJunBak @jubrad @kay-kim