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

Docs: Fix documents for document linter #24100

Merged
merged 2 commits into from
Jan 11, 2024
Merged

Conversation

wuxu92
Copy link
Contributor

@wuxu92 wuxu92 commented Dec 4, 2023

This PR is to fix some document issues since last fix. This PR will be ready to review when the Document linter CI turn on failing build when issue detected.

@@ -108,7 +108,7 @@ The following arguments are supported:

~> **Note:** Assigning the `virtual_network_subnet_id` property requires [RBAC permissions on the subnet](https://docs.microsoft.com/en-us/azure/app-service/overview-vnet-integration#permissions)

* `webdeploy_publish_basic_authentication_enabled` - Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to`true`.
* `webdeploy_publish_basic_authentication_enabled` - (Optional) Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to`true`. Defaults to `true`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

there is a number of these mistakes - duplicate text

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated. The tool cannot handle the origin Defaults to'true' so it append another Default to mark to it... I will try to update the tool to handle this.

Copy link
Member

@catriona-m catriona-m left a comment

Choose a reason for hiding this comment

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

Hi @wuxu92 - I had a look through this and left one more comment inline. Also it, looks like there are conflicts that need to be resolved before we can merge this. Otherwise this is looking good! Thanks!

@catriona-m
Copy link
Member

Thanks for fixing this up @wuxu92 - it looks like there is a conflict now but once that is resolved this should be good to go. Thanks!

@wuxu92
Copy link
Contributor Author

wuxu92 commented Jan 10, 2024

@catriona-m Thanks! I have rebase the main branch and fixed the confilict and other issues just now.

@@ -92,7 +92,7 @@ The following arguments are supported:

-> **NOTE:** Blobs with a tier of `Premium` are of account kind `StorageV2`.

* `account_replication_type` - (Required) Defines the type of replication to use for this storage account. Valid options are `LRS`, `GRS`, `RAGRS`, `ZRS`, `GZRS` and `RAGZRS`. Changing this forces a new resource to be created when types `LRS`, `GRS` and `RAGRS` are changed to `ZRS`, `GZRS` or `RAGZRS` and vice versa.
Copy link
Member

Choose a reason for hiding this comment

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

Is this comment still valid? Just wanted to double check since it was recently re-added in this pr #24414

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I reversed the change. I will update the tool to accommodate this case.

Copy link
Member

@catriona-m catriona-m left a comment

Choose a reason for hiding this comment

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

Thanks @wuxu92 LGTM!

@catriona-m catriona-m merged commit f10edee into hashicorp:main Jan 11, 2024
8 checks passed
@github-actions github-actions bot added this to the v3.87.0 milestone Jan 11, 2024
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants