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

Release docs for terraform version V1.4.0 #243

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

a-atri
Copy link
Collaborator

@a-atri a-atri commented Nov 20, 2024

Jira

  • AV-87721

Description

Release Documentation for Terraform version V1.4.0

Type of Change

  • Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
  • New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR.
  • Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR.
  • This change requires a documentation update
  • Documentation fix/enhancement

Manual Testing Approach

How was this change tested and do you have evidence? (REQUIRED: Select at least 1)

  • Manually tested
  • Unit tested
  • Acceptance tested
  • Unable to test / will not test (Please provide comments in section below)

Testing

Testing

Required Checklist:

  • I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
  • I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
  • I have added any necessary documentation (if required)
  • I have run make fmt and formatted my code
  • I have made sure that no schema field is marked with both requiresReplace and computed

Further comments

@a-atri a-atri requested review from a team as code owners November 20, 2024 15:36
Copy link

@simon-dew simon-dew left a comment

Choose a reason for hiding this comment

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

Quick scan of the documentation content. Couple of comments

docs/index.md Outdated Show resolved Hide resolved
docs/guides/1.4.0-upgrade-guide.md Show resolved Hide resolved
docs/guides/1.4.0-upgrade-guide.md Outdated Show resolved Hide resolved
Copy link

@simon-dew simon-dew left a comment

Choose a reason for hiding this comment

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

Adding to previous comments

docs/guides/1.4.0-upgrade-guide.md Outdated Show resolved Hide resolved
Copy link

@simon-dew simon-dew 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 my comments from previous review still stand. I'm not requesting changes at this stage so as not to block the PR.

Choose a reason for hiding this comment

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

  1. There are still two top-level headings in this file called Example Usage. Suggest changing the second one to Links to Further Examples or similar.
  2. Glad to see there are further descriptions under the links. The last few links (from Manage Private Endpoints onward) still just repeat the link text.

Choose a reason for hiding this comment

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

Feel free to dismiss this conversation and merge if you need to progress the PR

@simon-dew simon-dew dismissed their stale review November 29, 2024 13:46

Removing previous review as some comments have been addressed

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