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

[AV-86224] Generated docs for Terraform V1.3.0 #220

Merged
merged 9 commits into from
Sep 18, 2024

Conversation

a-atri
Copy link
Collaborator

@a-atri a-atri commented Sep 10, 2024

Jira

  • AV-86224

Description

Please include a summary of the fix/feature/change, including any relevant motivation and context.

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 September 10, 2024 06:55
Copy link
Contributor

@rajagp rajagp left a comment

Choose a reason for hiding this comment

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

@a-atri Maybe I missed changes to index.md. Could not find in PR We should update the example usage
https://registry.terraform.io/providers/couchbasecloud/couchbase-capella/latest/docs#example-usage-2

@a-atri
Copy link
Collaborator Author

a-atri commented Sep 12, 2024

@rajagp Updated the Index.md file

Copy link
Contributor

@Rebecca-Martinez007 Rebecca-Martinez007 left a comment

Choose a reason for hiding this comment

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

Just a few wording/punctuation changes. Waiting on a quick look over by @simon-dew. Should be good to go after that. I'll have this approved by EoD (EST) max - hopefully sooner.

docs/guides/1.3.0-upgrade-guide.md Outdated Show resolved Hide resolved
docs/guides/1.3.0-upgrade-guide.md Outdated Show resolved Hide resolved
docs/guides/1.3.0-upgrade-guide.md Outdated Show resolved Hide resolved
docs/guides/1.3.0-upgrade-guide.md Outdated Show resolved Hide resolved
docs/guides/1.3.0-upgrade-guide.md Outdated Show resolved Hide resolved
docs/guides/1.3.0-upgrade-guide.md Outdated Show resolved Hide resolved
docs/guides/1.3.0-upgrade-guide.md Outdated Show resolved Hide resolved
docs/guides/1.3.0-upgrade-guide.md Outdated Show resolved Hide resolved
docs/guides/1.3.0-upgrade-guide.md Outdated Show resolved Hide resolved
docs/guides/1.3.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.

The repeated text "see below for nested schema" looks generated. Is it configurable at all? I have some minor thoughts about the capitalization and punctuation of that phrase, but it's no blocker.

Other than that, I have nothing to add to @Rebecca-Martinez007 's comments

a-atri and others added 3 commits September 18, 2024 15:36
… team

Co-authored-by: Rebecca Martinez <167447972+Rebecca-Martinez007@users.noreply.github.com>
Co-authored-by: Rebecca Martinez <167447972+Rebecca-Martinez007@users.noreply.github.com>
Copy link
Contributor

@Rebecca-Martinez007 Rebecca-Martinez007 left a comment

Choose a reason for hiding this comment

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

Just a minor nit with the new sentence added for the deprecated field. Not a blocker, just a small suggestion. Thank you @a-atri !

Simon also left a small comment about the " (see [below for nested schema] " sentence.

docs/guides/1.3.0-upgrade-guide.md Outdated Show resolved Hide resolved
Co-authored-by: Rebecca Martinez <167447972+Rebecca-Martinez007@users.noreply.github.com>
Copy link
Contributor

@Rebecca-Martinez007 Rebecca-Martinez007 left a comment

Choose a reason for hiding this comment

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

@simon-dew we need to get this approval out, but @a-atri said we'd incorporate your feedback in the next Terraform release. I'm giving the approval here to move forward.

SaicharanCB
SaicharanCB previously approved these changes Sep 18, 2024
Copy link
Contributor

@SaicharanCB SaicharanCB left a comment

Choose a reason for hiding this comment

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

+1

Lagher0
Lagher0 previously approved these changes Sep 18, 2024
Copy link
Contributor

@nishant-tripathy nishant-tripathy left a comment

Choose a reason for hiding this comment

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

LGTM

@a-atri a-atri merged commit 15d9e09 into main Sep 18, 2024
4 checks passed
Lagher0 added a commit that referenced this pull request Oct 6, 2024
…cket

* origin/main:
  AV-78889 - VNET peering azure (#216)
  Av 87139 fix gorunner version (#232)
  Av 87139 fix gorunner version (#231)
  Av 87139 fix gorunner version (#230)
  AV-87139 fix gorunner version (#229)
  Updating the version for gorunner (#228)
  AV-87077 | handle computed values in acc test (#227)
  [AV-86105] initialized autoexpansion field with null value (#226)
  [AV-86503] Updated the changelog (#221)
  [AV-86224] Generated docs for Terraform V1.3.0 (#220)
  [AV-86845] Deprecate the `configurationType` attribute in the cluster resource (#222)
  Bump github.com/hashicorp/terraform-plugin-go from 0.22.1 to 0.23.0 (#193)
  Bump github.com/hashicorp/terraform-plugin-framework from 1.6.1 to 1.9.0 (#201)
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.

10 participants