fix: clarify organization_id and add import examples #259
+139
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JEETDESAI25
force-pushed
the
fix/issue-218-doc-org-id-import
branch
from
551e1b7 to
9c162f2
Compare
savme
reviewed
Nov 29, 2025
Collaborator
savme
left a comment
savme
left a comment
There was a problem hiding this comment.
Thanks for updating the docs, @JEETDESAI25! I think we can use a simpler approach for the import syntax descriptions
| } | ||
| resource "supabase_project" "production" { | ||
| # organization_id is your organization slug (found in dashboard URL) |
Collaborator
There was a problem hiding this comment.
Let’s mark the exact dashboard steps? Should help anyone new find it quickly
Suggested change
| # organization_id is your organization slug (found in dashboard URL) | |
| # organization_id is your organization's slug (it can be found in the Supabase Dashboard under Organization Settings > Organization Details > Organization slug) |
| - `user` (String) User | ||
| - `version` (String) Postgres version | ||
|
|
||
| ## Import |
Collaborator
There was a problem hiding this comment.
tfplugindocs supports documenting the import syntax via import.sh files placed in a resource's examples directory. I’d prefer this over modifying the templates, since we don’t really need anything custom there yet.
The usage of import.sh is documented here
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
Documentation improvement
What is the current behavior?
Closes #218
The
organization_idparameter lacks clarity, users don't know it refers to the organization slug found in the dashboard URL. Additionally, import documentation is missing for all resources (project, settings, branch).What is the new behavior?
organization_idschema description to specify it's the organization slugAdditional context
Regenerated docs via
go generate ./.... Minor merge conflict possible with PR #255 in project_resource.go (both changes should be kept).