Update develop-an-integration-as-an-api-service.md#1918
Update develop-an-integration-as-an-api-service.md#1918ChamaliSandamini wants to merge 1 commit into
Conversation
The "Develop an integration as an API service" guide was missing Step 2: Deploy the integration component. The steps jumped from Step 1 (Create) directly to Step 2 (Test), skipping the deployment step entirely. Additionally, the step numbering jumped from Step 2 directly to Step 4 with no Step 3. Changes made: - Added missing Step 2: Deploy the integration component with all sub-steps - Renamed the existing Step 2 (Test the integration) to Step 3
|
|
📝 WalkthroughSummaryThis PR updates the "Develop an integration as an API service" documentation guide by adding the previously missing Step 2: Deploy the integration component section. Changes
ImpactRestores the complete workflow documentation with all required steps in the correct order. The guide now properly guides users through the full integration development lifecycle: Create → Deploy → Test. Lines changed: +16 / -1 WalkthroughThe PR updates the API service integration development guide by inserting a new Step 2 section that covers deploying the integration component. This section includes console navigation instructions and deployment status guidance, with a tip about automatic deployment. The previously numbered Step 2 (Test the integration) is renumbered to Step 3, shifting the remaining workflow steps accordingly. The change adds 16 lines and removes 1 line from the documentation file. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@en/developer-docs/docs/develop-components/develop-integrations/develop-an-integration-as-an-api-service.md`:
- Around line 45-55: The doc currently contradicts itself: Step 1 says "Create
and Deploy" performs deployment, while "Step 2: Deploy the integration
component" repeats deployment. Choose one clear workflow and update the text
accordingly: either change the Step 1 action text "Click Create and Deploy" to
"Click Create" (or "Create") and leave Step 2 as the single deploy flow, or keep
Step 1 as "Create and Deploy" and reword Step 2 to "Verify deployment / Redeploy
if needed" and change the bullets under "Step 2: Deploy the integration
component" to verification steps (e.g., open Deploy, view Build Area, confirm
Development card shows Deployment Status: Active). Apply the same resolution to
the repeated instance referenced in lines 60-62.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 177b6091-a68f-47af-8a43-f8d3985e18fa
📒 Files selected for processing (1)
en/developer-docs/docs/develop-components/develop-integrations/develop-an-integration-as-an-api-service.md
| 8. Click **Create and Deploy**. {{ product_name }} initializes the component, builds it, and deploys it to the development environment. | ||
|
|
||
| ## Step 2: Test the integration | ||
| ## Step 2: Deploy the integration component | ||
|
|
||
| To deploy the integration component to the development environment, follow the steps given below: | ||
|
|
||
| 1. In the {{ product_name }} Console left navigation menu, click **Deploy**. | ||
| 2. In the **Build Area** card, click **Configure & Deploy**. | ||
| 3. In the **Configurations** pane, click **Next**. This displays details of the endpoint ready to be deployed. | ||
| 4. Click **Deploy**. This deploys the integration component to the development environment. | ||
| The **Development** card indicates the **Deployment Status** as **Active** when the integration is successfully deployed. |
There was a problem hiding this comment.
Resolve the deployment flow inconsistency between Step 1 and Step 2.
Line 45 says Create and Deploy already deploys the component, but Step 2 then asks the reader to deploy again. Please align these steps so the workflow has a single clear deployment action (for example, either change Step 1 to creation-only, or clarify Step 2 as verification/redeployment when needed).
Also applies to: 60-62
🧰 Tools
🪛 LanguageTool
[style] ~53-~53: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... card, click Configure & Deploy. 3. In the Configurations pane, click **Ne...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In
`@en/developer-docs/docs/develop-components/develop-integrations/develop-an-integration-as-an-api-service.md`
around lines 45 - 55, The doc currently contradicts itself: Step 1 says "Create
and Deploy" performs deployment, while "Step 2: Deploy the integration
component" repeats deployment. Choose one clear workflow and update the text
accordingly: either change the Step 1 action text "Click Create and Deploy" to
"Click Create" (or "Create") and leave Step 2 as the single deploy flow, or keep
Step 1 as "Create and Deploy" and reword Step 2 to "Verify deployment / Redeploy
if needed" and change the bullets under "Step 2: Deploy the integration
component" to verification steps (e.g., open Deploy, view Build Area, confirm
Development card shows Deployment Status: Active). Apply the same resolution to
the repeated instance referenced in lines 60-62.
2 participants
The "Develop an integration as an API service" guide was missing Step 2: Deploy the integration component. The steps jumped from Step 1 (Create) directly to Step 2 (Test), skipping the deployment step entirely. Additionally, the step numbering jumped from Step 2 directly to Step 4 with no Step 3.
Changes made:
Description
Type of change
Testing
Related issues