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

Improve uuid usage in bal persist learn page #8141

Closed
HindujaB opened this issue Oct 31, 2023 · 2 comments · Fixed by #8164
Closed

Improve uuid usage in bal persist learn page #8141

HindujaB opened this issue Oct 31, 2023 · 2 comments · Fixed by #8164
Assignees
Labels
Area/LearnPages Issues related to all the pages of the Learn section. Category/Content All written content related issues (Technical content, english language etc) Type/Improvement Improvements required on the website.

Comments

@HindujaB
Copy link
Contributor

Description

$subject

The persist learn page uses an Employee record to add to the data store.
https://ballerina.io/learn/manage-data-persistence-with-bal-persist/#create-a-new-employee-record

The provided sample uses uuid:createType4AsString() to create a unique id. And in the samples that follow it uses a hard-coded string as an id to retrieve/modify/delete the record entries.
https://ballerina.io/learn/manage-data-persistence-with-bal-persist/#retrieve-the-employee-record-by-key

As the generated id can differ randomly, the further samples can fail which may confuse the user.
Similar to the other learn pages, it's better to provide a step-by-step approach to the users where the code context can be gradually developed.

Related website/documentation area

Add/Uncomment the relevant area label out of the following.

Describe the problem(s)

A detailed description of the purpose of this improvement.

Describe your solution(s)

A detailed description of how this improvement will solve the problem described above.

Related issue(s) (optional)

Any related issues such as sub tasks and issues reported in other repositories (e.g., component repositories), similar problems, etc.

Suggested label(s) (optional)

Optional comma-separated list of suggested labels. Non committers can’t assign labels to issues, and thereby, this will help issue creators who are not a committer to suggest possible labels.

Suggested assignee(s) (optional)

Optional comma-separated list of suggested team members who should attend the issue. Non committers can’t assign issues to assignees, and thereby, this will help issue creators who are not a committer to suggest possible assignees.

@HindujaB HindujaB added Type/Improvement Improvements required on the website. Area/LearnPages Issues related to all the pages of the Learn section. labels Oct 31, 2023
@praneesha praneesha self-assigned this Oct 31, 2023
@praneesha praneesha added the Category/Content All written content related issues (Technical content, english language etc) label Nov 1, 2023
@praneesha
Copy link

The fix will be changed via #8230.

@praneesha praneesha reopened this Nov 9, 2023
@praneesha
Copy link

Closing as the change is done via #8230.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area/LearnPages Issues related to all the pages of the Learn section. Category/Content All written content related issues (Technical content, english language etc) Type/Improvement Improvements required on the website.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants