Skip to content

Conversation

mjyocca
Copy link
Contributor

@mjyocca mjyocca commented Jun 15, 2022

Adding new documentation for terraform cloud api runs list around new query parameters

Task Link


@vercel
Copy link

vercel bot commented Jun 15, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
terraform-docs-common ✅ Ready (Inspect) Visit Preview Jun 27, 2022 at 6:07PM (UTC)

@aaabdelgany aaabdelgany requested a review from laurapacilio June 16, 2022 13:15
Copy link
Contributor

@laurapacilio laurapacilio left a comment

Choose a reason for hiding this comment

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

Approving so I don't block you, but a couple of minor edits. Largely, we want to try to stay away from italics when possible, so I incorporated those statements into the main text. Also! We want to use the most descriptive link text we can, so that users know what we mean. It's also helpful if, say, someone changes that subheading in the future but doesn't update the link. This will help users still find the information.

Thank you!

@mjyocca
Copy link
Contributor Author

mjyocca commented Jun 17, 2022

Approving so I don't block you, but a couple of minor edits. Largely, we want to try to stay away from italics when possible, so I incorporated those statements into the main text. Also! We want to use the most descriptive link text we can, so that users know what we mean. It's also helpful if, say, someone changes that subheading in the future but doesn't update the link. This will help users still find the information.

Thank you!

@laurapacilio Thanks for the great feedback! I went ahead and made the suggested changes.

@mjyocca mjyocca force-pushed the mjyocca/runs-list-api-changes branch from 1da51a4 to 0e940ad Compare June 21, 2022 22:18
@mjyocca mjyocca marked this pull request as ready for review June 21, 2022 22:18
@mjyocca mjyocca requested a review from laurapacilio June 21, 2022 22:18
Copy link
Contributor

@laurapacilio laurapacilio left a comment

Choose a reason for hiding this comment

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

A couple of suggestions for you, but otherwise LGTM!

Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
@mjyocca
Copy link
Contributor Author

mjyocca commented Jun 23, 2022

A couple of suggestions for you, but otherwise LGTM!

Awesome, thank you again for the feedback!

@mjyocca mjyocca merged commit 7436948 into main Jun 27, 2022
@mjyocca mjyocca deleted the mjyocca/runs-list-api-changes branch June 27, 2022 18:09
@dylanegan
Copy link
Contributor

@mjyocca @laurapacilio it looks like the API changelog wasn't updated to reflect these changes. Should these be included?

@laurapacilio
Copy link
Contributor

Yes :) @dylanegan thank you! @mjyocca would you mind please opening another PR to add this to the changelog file? https://ptfe-releases-gg5iuzrts-hashicorp.vercel.app/enterprise/api-docs/changelog

@mjyocca
Copy link
Contributor Author

mjyocca commented Jul 19, 2022

@laurapacilio @dylanegan I'll go ahead and make the requested changes!

@laurapacilio laurapacilio mentioned this pull request Jul 25, 2022
14 tasks
hashibot-web added a commit that referenced this pull request May 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants