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

Improvement suggestions for ETL page #8604

Closed
anupama-pathirage opened this issue Jan 25, 2024 · 4 comments
Closed

Improvement suggestions for ETL page #8604

anupama-pathirage opened this issue Jan 25, 2024 · 4 comments
Assignees
Labels
Type/Improvement Improvements required on the website.

Comments

@anupama-pathirage
Copy link
Contributor

Description

1. Be consistent on the wording Realtime vs real-time. It is better to use the hyphenated form "real-time," which is more commonly accepted and used in formal writing.

2. It seems both title case and sentence case is used in blade titles. Be consistent and use sentence case always.

3. Can we use backticks to highlight the text instead of single quotes?
image

4. Better to use configurables?
image

5. Do we really need the retry config? As it is optional and not related to the concept explained in the blade, isn't it better to remove it?
image

6. Can we link to an example of data mapper too?
image

@anupama-pathirage anupama-pathirage added the Type/Improvement Improvements required on the website. label Jan 25, 2024
@anupama-pathirage anupama-pathirage changed the title Improvement suggestions for ETP page Improvement suggestions for ETL page Jan 25, 2024
@LakshanWeerasinghe LakshanWeerasinghe self-assigned this Jan 26, 2024
@pcnfernando
Copy link
Member

pcnfernando commented Jan 26, 2024

5. Do we really need the retry config? As it is optional and not related to the concept explained in the blade, isn't it better to remove it? image

I don't see harm in removing it. But, this is coming from the AI usecase samples https://ballerina.io/usecases/ai/#write-robust-api-powered-ai-applications
Do you think both use cases should be updated? @anupama-pathirage

@anupama-pathirage
Copy link
Contributor Author

2. It seems both title case and sentence case is used in blade titles. Be consistent and use sentence case always.

This is not fixed. Check other two similar sub titles.

image

4. Better to use configurables?

Add githubAccessToken also as a configurable.
image

@anupama-pathirage
Copy link
Contributor Author

5. Do we really need the retry config? As it is optional and not related to the concept explained in the blade, isn't it better to remove it? image

I don't see harm in removing it. But, this is coming from the AI usecase samples https://ballerina.io/usecases/ai/#write-robust-api-powered-ai-applications Do you think both use cases should be updated? @anupama-pathirage

It is fine to have it in AI page in that explicit sample as its main point is about robust apis. So retry is a good thing to explain the robustness there.

But in the Refining data excellence title of the ETL page, we are talking about AI capabilities. So IMO it is an overhead to have retry config here.

@anupama-pathirage
Copy link
Contributor Author

Closing as this is done and page is live. https://ballerina.io/usecases/etl/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type/Improvement Improvements required on the website.
Projects
None yet
Development

No branches or pull requests

4 participants