Apply default docs edit rules to installation docs #2211
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iwahbe
changed the title
iwahbe
reviewed
Jul 19, 2024
Comment on lines
+30
to
+34
| contentBytes, err := applyEditRules([]byte(contentStr), docFile) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return contentBytes, nil |
There was a problem hiding this comment.
Suggested change
| contentBytes, err := applyEditRules([]byte(contentStr), docFile) | |
| if err != nil { | |
| return nil, err | |
| } | |
| return contentBytes, nil | |
| return applyEditRules([]byte(contentStr), docFile) |
There was a problem hiding this comment.
in next PRs I'll be adding more here so I'll need the contentBytes for the next transformation 😅
pkg/tfgen/installation_docs.go
Outdated
Comment on lines
100
to
120
| // Obtain default edit rules for documentation files | ||
| edits := defaultEditRules() | ||
|
|
||
| // Additional edit rules for installation files | ||
| installationFileEdits := editRules{ | ||
| // Replace all "T/terraform" with "P/pulumi" | ||
| reReplace(`Terraform`, `Pulumi`), | ||
| reReplace(`terraform`, `pulumi`), | ||
| // Replace all "H/hashicorp" strings | ||
| reReplace(`Hashicorp`, `Pulumi`), | ||
| reReplace(`hashicorp`, `pulumi`), | ||
| // Reformat certain headers | ||
| reReplace(`The following arguments are supported`, | ||
| `The following configuration inputs are supported`), | ||
| reReplace(`Argument Reference`, | ||
| `Configuration Reference`), | ||
| reReplace(`block contains the following arguments`, | ||
| `input has the following nested fields`), | ||
| } | ||
|
|
||
| edits = append(edits, installationFileEdits...) |
There was a problem hiding this comment.
I think the shorter version reads better.
Suggested change
| // Obtain default edit rules for documentation files | |
| edits := defaultEditRules() | |
| // Additional edit rules for installation files | |
| installationFileEdits := editRules{ | |
| // Replace all "T/terraform" with "P/pulumi" | |
| reReplace(`Terraform`, `Pulumi`), | |
| reReplace(`terraform`, `pulumi`), | |
| // Replace all "H/hashicorp" strings | |
| reReplace(`Hashicorp`, `Pulumi`), | |
| reReplace(`hashicorp`, `pulumi`), | |
| // Reformat certain headers | |
| reReplace(`The following arguments are supported`, | |
| `The following configuration inputs are supported`), | |
| reReplace(`Argument Reference`, | |
| `Configuration Reference`), | |
| reReplace(`block contains the following arguments`, | |
| `input has the following nested fields`), | |
| } | |
| edits = append(edits, installationFileEdits...) | |
| edits := append(defaultEditRules(), | |
| // Replace all "T/terraform" with "P/pulumi" | |
| reReplace(`Terraform`, `Pulumi`), | |
| reReplace(`terraform`, `pulumi`), | |
| // Replace all "H/hashicorp" strings | |
| reReplace(`Hashicorp`, `Pulumi`), | |
| reReplace(`hashicorp`, `pulumi`), | |
| // Reformat certain headers | |
| reReplace(`The following arguments are supported`, | |
| `The following configuration inputs are supported`), | |
| reReplace(`Argument Reference`, | |
| `Configuration Reference`), | |
| reReplace(`block contains the following arguments`, | |
| `input has the following nested fields`), | |
| ) |
There was a problem hiding this comment.
works for me!
guineveresaenger
force-pushed
the
guin/default-doc-edit-rules
branch
from
d15f94b to
c956c49
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2211 +/- ##
==========================================
+ Coverage 60.59% 60.61% +0.01%
==========================================
Files 356 356
Lines 46338 46368 +30
==========================================
+ Hits 28079 28105 +26
- Misses 16701 16705 +4
Partials 1558 1558 ☔ View full report in Codecov by Sentry. |
|
This PR has been shipped in release v3.88.0. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds default doc edit rules plus a few more installation-doc specific edit rules to the plain docs parser functionality.
Fixes #2208