Skip to content
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.

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

Update team ID description in docs #119

Merged
merged 9 commits into from
Jun 19, 2023
Merged

Conversation

kitfoster
Copy link
Collaborator

Currently it's unclear that the team_id needs to be specified for team resources which leads to confusing permission errors.

@balazs4
Copy link
Member

balazs4 commented Jun 19, 2023

@dglsparsons I wonder if task docs is still the way to generate docs because if I run it on main, there are a few parameters they became Optional instead of Required.

I would add the new team_id related comments to Description fields within the provider, and let task docs generate the docs for us. Any thoughts?

@dglsparsons
Copy link
Collaborator

dglsparsons commented Jun 19, 2023

@dglsparsons I wonder if task docs is still the way to generate docs because if I run it on main, there are a few parameters they became Optional instead of Required.

Interesting. It should be correct. I don't see any differences from rerunning task docs 🤔

I've been meaning to go and update the Description fields to reflect these changes. Just have been on offsite last week. :)

Edit: my docs task was cached, but seemed to be invalid. Oops. (oh, it's an old version of the tfplugindocs causing the issue for me).

@dglsparsons dglsparsons merged commit e5c8729 into main Jun 19, 2023
@dglsparsons dglsparsons deleted the update-team-id-description branch June 19, 2023 10:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants