Skip to content
This repository has been archived by the owner on Jul 5, 2023. It is now read-only.

Added the Comments API docs #2189

Merged
merged 2 commits into from Mar 21, 2022
Merged

Added the Comments API docs #2189

merged 2 commits into from Mar 21, 2022

Conversation

sebasslash
Copy link
Contributor

Adding documentations for the comments API. Support for the comments API will be added to go-tfe and thus go-tfe's docs need to be able to reference a API documentation page that exists.

@vercel
Copy link

vercel bot commented Mar 16, 2022

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/hashicorp/terraform-website/Bw4Xcq7Qsm9MqmRu2g3v2SXne8qP
✅ Preview: https://terraform-website-git-sebasslash-comments-api-hashicorp.vercel.app


# Comments API

A Comment represents a Terraform Enterprise comment.
Copy link
Contributor

Choose a reason for hiding this comment

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

Where would we find a Terraform Enterprise comment? I'm wondering if more description of what a comment is might be helpful here. What do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

I 100% agree with this! Can we provide a more detailed descriptions of what comments are? Also - is this NOT relevant to terraform cloud? If so, I think we should explicitly say that here. If it IS relevant, then what does it look like in TFC? I just noted that we explicitly say "Terraform Enterprise" which makes me think it's not relevant to TFC

Copy link
Contributor

@annawinkler annawinkler left a comment

Choose a reason for hiding this comment

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

🥇 Thank you for adding the docs for this API! I have one question/comment that isn't a blocker.

Copy link
Contributor

@annawinkler annawinkler left a comment

Choose a reason for hiding this comment

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

💯 Looks good to me! Thank you.

@sebasslash sebasslash merged commit 5c2ebc5 into master Mar 21, 2022
@sebasslash sebasslash deleted the sebasslash/comments-api branch March 21, 2022 22:10
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants