-
Notifications
You must be signed in to change notification settings - Fork 258
Correct docs in import with Diff
#16580
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
Conversation
Documentation ReviewI've reviewed the changes to the import documentation. Overall, this PR accurately reflects the behavior change from pulumi/pulumi#19339. Here are my findings: ✅ Positive Changes
📝 Issues Found1. Grammar issue (line 199)File: content/docs/iac/concepts/resources/options/import.md:199 The phrase "the import will succeed and then the resource will be modified" could be clearer. Consider: Rationale: Adding a comma after "succeed" improves readability in this compound sentence. 2. Terminology consistency (line 220)File: content/docs/iac/concepts/resources/options/import.md:220 The term "import-update" is introduced without prior explanation and may be confusing. Consider: Rationale: "import-update" is not a standard Pulumi term and may confuse readers. The revised text is clearer and more natural. 3. Code block language tag (line 201)File: content/docs/iac/concepts/resources/options/import.md:201 The code fence uses console but according to STYLE-GUIDE.md, console output should use output or bash for commands. Since this shows command + output, consider splitting or using bash: Rationale: Consistency with style guide for code block language tags. SummaryThe PR successfully updates the documentation to reflect the new import behavior. The three issues above are minor style and clarity improvements. The content is technically accurate and the example is helpful. Need additional reviews or want me to help fix these issues? Mention @claude in a comment. |
|
@claude Please implement your suggestions. For (3), let's use bash. |
|
Claude finished @iwahbe's task —— View job Implementing Review SuggestionsTasks
SummaryI've successfully implemented all three review suggestions:
All changes have been committed and pushed to the PR branch. --- | |
The behavior of import changed with pulumi/pulumi#19339, and our docs should reflect the current behavior.
- Improve grammar in line 199 by adding comma after 'succeed' - Replace 'import-update' terminology with clearer phrasing on line 220 - Change code block language tag from console to bash on line 201 Co-authored-by: Ian Wahbe <[email protected]>
56bea11 to
c56e459
Compare
|
Your site preview for commit c56e459 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16580-c56e459e.s3-website.us-west-2.amazonaws.com. |
The behavior of import changed with pulumi/pulumi#19339, and our docs should reflect the current behavior.
Proposed changes
Unreleased product version (optional)
Related issues (optional)