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

Add file integration sample #55

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

anuruddhal
Copy link
Member

@anuruddhal anuruddhal requested a review from Copilot April 2, 2025 08:12
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a file integration sample for the Ballerina Integrator, following a related issue.

  • Updated the navigation file (mkdocs.yml) to include the new file integration section.
  • Added a new documentation file (file-integration.md) with a step-by-step guide and reference images for file integration.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

File Description
en/mkdocs.yml Updated navigation to include file integration documentation.
en/docs/learn/file-integration.md Added file integration sample documentation with step-by-step instructions and images.

Comment on lines 19 to 20
<a href="{{base_path}}/assets/img/file-integration/directroy-service.gif"><img src="{{base_path}}/assets/img/file-integration/directroy-service.gif" alt="Create Directory Service" width="70%"></a>

Copy link
Preview

Copilot AI Apr 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo detected in the file name 'directroy-service.gif'. It should be corrected to 'directory-service.gif'.

Suggested change
<a href="{{base_path}}/assets/img/file-integration/directroy-service.gif"><img src="{{base_path}}/assets/img/file-integration/directroy-service.gif" alt="Create Directory Service" width="70%"></a>
<a href="{{base_path}}/assets/img/file-integration/directory-service.gif"><img src="{{base_path}}/assets/img/file-integration/directory-service.gif" alt="Create Directory Service" width="70%"></a>

Copilot is powered by AI, so mistakes are possible. Review output carefully before use.


### Step 4: Run the integration
1. Click on the **`Run`** button in the top-right corner to run the integration.
2. The integration will start wil listening to the events in the specified directory in step 2.
Copy link
Preview

Copilot AI Apr 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo found: 'wil listening' should be corrected to 'will be listening'.

Suggested change
2. The integration will start wil listening to the events in the specified directory in step 2.
2. The integration will start will be listening to the events in the specified directory in step 2.

Copilot is powered by AI, so mistakes are possible. Review output carefully before use.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a file integration sample as part of the documentation updates for the Ballerina Integrator, aiming to provide step-by-step guidance for integrating file-based events.

  • Added a new navigation entry for File Integration in the mkdocs.yml file.
  • Introduced a new documentation file with detailed steps, screenshots, and instructions on setting up file integration.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

File Description
en/mkdocs.yml Added a navigation entry for the new File Integration documentation.
en/docs/learn/file-integration.md New document outlining the process to create a file integration sample.


### Step 3: Add a file event resources
1. Navigate to the `directoryListener` service and click on the **`+Function`** button.
2. Select **`onCreate`** from **`Available Functions*`** dropdown and click on the **`Save`** button.
Copy link
Preview

Copilot AI Apr 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] There appears to be a markdown formatting error with the asterisk in 'Available Functions*'. Consider removing the extra asterisk so it reads 'Available Functions'.

Suggested change
2. Select **`onCreate`** from **`Available Functions*`** dropdown and click on the **`Save`** button.
2. Select **`onCreate`** from **`Available Functions`** dropdown and click on the **`Save`** button.

Copilot is powered by AI, so mistakes are possible. Review output carefully before use.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a sample for file integration to the Ballerina Integrator documentation.

  • Introduces a new file integration sample document with step-by-step instructions.
  • Updates the navigation file to include the new sample.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

File Description
en/mkdocs.yml Adds "File integration" to the documentation navigation.
en/docs/learn/file-integration.md Provides a new guide for setting up file integration.


### Step 4: Run the integration
1. Click on the **`Run`** button in the top-right corner to run the integration.
2. The integration will start will be listening to the events in the specified directory in step 2.
Copy link
Preview

Copilot AI Apr 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a duplicated 'will' in the sentence. Consider revising it to: 'The integration will start listening to the events in the specified directory in step 2.'

Suggested change
2. The integration will start will be listening to the events in the specified directory in step 2.
2. The integration will start listening to the events in the specified directory in step 2.

Copilot is powered by AI, so mistakes are possible. Review output carefully before use.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a new file integration sample and updates the documentation navigation for easy access.

  • Adds a new documentation file describing a step-by-step file integration sample
  • Updates the navigation in the mkdocs configuration to include the file integration section

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

File Description
en/mkdocs.yml Navigation updated to include file integration
en/docs/learn/file-integration.md New documentation covering file integration sample
Comments suppressed due to low confidence (2)

en/docs/learn/file-integration.md:1

  • [nitpick] Consider capitalizing the heading consistently as 'File Integration' to match the style used in other documentation sections.
# File integration

en/docs/learn/file-integration.md:21

  • [nitpick] The heading 'Add a file event resources' could be rephrased for clarity, for example, 'Configure File Event Resources'.
### Step 3: Add a file event resources


### Step 4: Run the integration
1. Click on the **`Run`** button in the top-right corner to run the integration.
2. The integration will start listening to the events in the specified directory in step 2.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. The integration will start listening to the events in the specified directory in step 2.
2. The integration will start listening to the events in the directory specified in step 2.

@anuruddhal anuruddhal force-pushed the main branch 3 times, most recently from 4448198 to 1d5b9ce Compare April 3, 2025 04:14
<a href="{{base_path}}/assets/img/file-integration/directory-service.gif"><img src="{{base_path}}/assets/img/file-integration/directory-service.gif" alt="Create Directory Service" width="70%"></a>

### Step 3: Configure File Event Resources
1. Navigate to the `directoryListener` service and click on the **`+Function`** button.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Navigate to the `directoryListener` service and click on the **`+Function`** button.
1. Navigate to the `directoryListener` service under the `Entry Points` section and click on the **`+Function`** button.

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

Successfully merging this pull request may close these issues.

3 participants