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

Fix collapsed markdown for enum values on Terraform website #3783

Merged
merged 2 commits into from
Aug 3, 2020
Merged

Fix collapsed markdown for enum values on Terraform website #3783

merged 2 commits into from
Aug 3, 2020

Conversation

nownabe
Copy link
Contributor

@nownabe nownabe commented Jul 25, 2020

Release Note Template for Downstream PRs (will be copied)

Fix markdown for enum values

I fixed a collapsed markdown for enum values on the Terraform website.

Current docs are like the following:

Screenshot from 2020-07-25 14-22-56

https://www.terraform.io/docs/providers/google/r/dns_managed_zone.html#visibility

Sample diff made by this PR:

diff --git a/website/docs/r/app_engine_domain_mapping.html.markdown b/website/docs/r/app_engine_domain_mapping.html.markdown
index 14b8bad2..4146a26a 100644
--- a/website/docs/r/app_engine_domain_mapping.html.markdown
+++ b/website/docs/r/app_engine_domain_mapping.html.markdown
@@ -64,18 +64,15 @@ The following arguments are supported:
 
 * `ssl_settings` -
   (Optional)
-  SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.  Structure is documented below.
+  SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
+  Structure is documented below.
 
 * `override_strategy` -
   (Optional)
   Whether the domain creation should override any existing mappings for this domain.
   By default, overrides are rejected.
-
-  Default value: `STRICT`
-
-  Possible values are:
-  * `STRICT`
-  * `OVERRIDE`
+  Default value is `STRICT`.
+  Possible values are `STRICT` and `OVERRIDE`.
 
 * `project` - (Optional) The ID of the project in which the resource belongs.
     If it is not provided, the provider project is used.

nownabe added 2 commits July 25, 2020 14:17
On the website, the style for default value and possible values is collapsed now.
Because all other portions have a new line at end.
@google-cla google-cla bot added the cla: yes label Jul 25, 2020
@modular-magician
Copy link
Collaborator

Hello! I am a robot who works on Magic Modules PRs.

I have detected that you are a community contributor, so your PR will be assigned to someone with a commit-bit on this repo for initial review.

Thanks for your contribution! A human will be with you soon.

@ndmckinley, please review this PR or find an appropriate assignee.

@modular-magician
Copy link
Collaborator

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 109 files changed, 1249 insertions(+), 1636 deletions(-))
Terraform Beta: Diff ( 130 files changed, 1485 insertions(+), 1927 deletions(-))

@modular-magician
Copy link
Collaborator

I have triggered VCR tests based on this PR's diffs. See the results here: "https://ci-oss.hashicorp.engineering/viewQueued.html?itemId=135668"

Copy link
Contributor

@nat-henderson nat-henderson 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, the diff looks great.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants