docs: add SDM release troubleshooting info#157
Conversation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Co-authored-by: Christo Grabowski <108154848+ChristoGrab@users.noreply.github.com>
Aaron ("AJ") Steers (aaronsteers)
marked this pull request as ready for review
📝 WalkthroughWalkthroughThe pull request updates the Changes
Possibly related PRs
Suggested reviewers
What do you think about reaching out to these reviewers for their insights? Wdyt? Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (5)
docs/RELEASES.md (5)
34-34: Minor typo in "Manifest"There's a small typo in "Manfiest" - should be "Manifest". Wdyt about fixing this? 🔍
-Source Declarative Manfiest code +Source Declarative Manifest code
42-42: Consider adding a comma for better readabilityWould you consider adding a comma before "so" to improve the flow? 🤔
-Currently we don't pre-test images in Platform so manual testing is needed. +Currently we don't pre-test images in Platform, so manual testing is needed.🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...tly we don't pre-test images in Platform so manual testing is needed. ### How to c...(COMMA_COMPOUND_SENTENCE_2)
50-50: Grammar: Article usage with "Builder-created"Should we change "an Builder-created" to "a Builder-created" since "Builder" starts with a consonant sound? 📝
-you can run an Builder-created connector +you can run a Builder-created connector🧰 Tools
🪛 LanguageTool
[misspelling] ~50-~50: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...not available as an option, you can run an Builder-created connector in Cloud and ...(EN_A_VS_AN)
52-52: Consider tracking the TODO as an issueThis TODO about finding alternatives to direct prod DB access seems important for security and accessibility. Would you like me to help create a GitHub issue to track this? 🤝
74-82: Consider adding prerequisites for Cloud testingThe Cloud testing section provides good steps, but what do you think about adding prerequisites like:
- Required access levels
- Backup recommendations
- Rollback procedures in case of issues
This could help prevent accidental issues when working with prod DB. Wdyt? 🛡️
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
docs/RELEASES.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/RELEASES.md
[grammar] ~36-~36: Did you mean the noun “publishing”?
Context: ...ect to change this in the future.) Our publish flow sends a PR to the Builder repo (`a...
(PREPOSITION_VERB)
[uncategorized] ~42-~42: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...tly we don't pre-test images in Platform so manual testing is needed. ### How to c...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~45-~45: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...at SDM version is used on the Platform Currently there are two ways to do this. The fir...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[misspelling] ~50-~50: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...not available as an option, you can run an Builder-created connector in Cloud and ...
(EN_A_VS_AN)
[grammar] ~60-~60: Did you mean the noun “publishing”?
Context: ...ting Manifest-Only connectors Once the publish pipeline has completed, choose a connec...
(PREPOSITION_VERB)
[grammar] ~68-~68: Did you mean the noun “publishing”?
Context: ...ng Low-Code Python connectors Once the publish pipeline has completed, set the version...
(PREPOSITION_VERB)
🔇 Additional comments (1)
docs/RELEASES.md (1)
30-82: Great addition to the documentation! 👏
The new sections provide valuable insights into the SDM release process and testing procedures. The structure is clear and the warnings about production access are appropriately emphasized.
🧰 Tools
🪛 LanguageTool
[grammar] ~36-~36: Did you mean the noun “publishing”?
Context: ...ect to change this in the future.) Our publish flow sends a PR to the Builder repo (`a...
(PREPOSITION_VERB)
[uncategorized] ~42-~42: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...tly we don't pre-test images in Platform so manual testing is needed. ### How to c...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~45-~45: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...at SDM version is used on the Platform Currently there are two ways to do this. The fir...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[misspelling] ~50-~50: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...not available as an option, you can run an Builder-created connector in Cloud and ...
(EN_A_VS_AN)
[grammar] ~60-~60: Did you mean the noun “publishing”?
Context: ...ting Manifest-Only connectors Once the publish pipeline has completed, choose a connec...
(PREPOSITION_VERB)
[grammar] ~68-~68: Did you mean the noun “publishing”?
Context: ...ng Low-Code Python connectors Once the publish pipeline has completed, set the version...
(PREPOSITION_VERB)
Aaron ("AJ") Steers (aaronsteers)
deleted the
aj/docs/update-release-docs-with-sdm-troubleshooting-f
branch
2 participants
This PR adds context for how to troubleshoot releases, including context on what is deployed where - and how to test/monitor different components of the process.
Note: I need help to fill out the "TODO" sections. If you use the "suggestions" feature in GitHub, or just comment here in the PR with additional info, I'll take these inputs and merge those back into the instructions docs.
Summary by CodeRabbit
RELEASES.mddocument with a new section on understanding and debugging Builder and SDM releases.