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.

Sign up for GitHub

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

Jump to bottom

Improve the explanation about backtick templates #5819

Merged
merged 9 commits into from
Nov 19, 2024
Merged

Improve the explanation about backtick templates #5819

merged 9 commits into from
Nov 19, 2024

Conversation

heshanpadmasiri
Copy link
Member

Purpose

$subject
Resolves ballerina-platform/ballerina-dev-website#9281

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email [email protected] to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to [email protected] and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

MaryamZi
MaryamZi reviewed Nov 8, 2024
View reviewed changes
examples/regex-templates/regex_templates.bal Outdated Show resolved Hide resolved
examples/string-templates/string_templates.bal Outdated Show resolved Hide resolved
examples/string-templates/string_templates.bal Outdated
string s1 = string `line one \n rest of line 1 ${"\n"} second line`;
io:println(s1);

// You can use interpolations to add ` and $ characters.
Copy link
Member

Choose a reason for hiding this comment

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

Need to emphasize the characters using backticks. Need to check if/how this can be done.

Copy link
Member Author

@heshanpadmasiri heshanpadmasiri Nov 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

As far as I know we can't use markdown-ish formatting in side source code, they are rendered as is (example). I didn't add backticks around ` since it would be confusing to the user (In markdown I believe you have wrap ` in side double backticks ``)

examples/string-templates/string_templates.bal Outdated Show resolved Hide resolved
examples/string-templates/string_templates.bal Outdated Show resolved Hide resolved
examples/string-templates/string_templates.bal Outdated Show resolved Hide resolved
examples/string-templates/string_templates.md Outdated Show resolved Hide resolved
MaryamZi
MaryamZi reviewed Nov 12, 2024
View reviewed changes
examples/index.json
"isLearnByExample": true
},
{
"name": "Backtick templates",
"url": "backtick-templates",
"name": "String templates",
Copy link
Member

Choose a reason for hiding this comment

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

I believe we need to handle redirection for this. cc @sm1990

Copy link
Contributor

Choose a reason for hiding this comment

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

@heshanpadmasiri please share the old url and the new url to update the google indexing

Copy link
Member Author

@heshanpadmasiri heshanpadmasiri Nov 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Old: https://ballerina.io/learn/by-example/backtick-templates/ new (after deploying, currently there is no such page) https://ballerina.io/learn/by-example/string-templates/

examples/string-templates/string_templates.bal Outdated Show resolved Hide resolved
examples/string-templates/string_templates.bal Outdated Show resolved Hide resolved
examples/string-templates/string_templates.md Outdated Show resolved Hide resolved
examples/string-templates/string_templates.bal Outdated Show resolved Hide resolved
@heshanpadmasiri heshanpadmasiri force-pushed the feat/backtick-template branch 2 times, most recently from cab435b to 489589e Compare November 13, 2024 03:10
@heshanpadmasiri @MaryamZi
Address review comments
714c721 
Co-Authored-By: Maryam Ziyad <[email protected]>
@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Nov 18, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@MaryamZi MaryamZi added this pull request to the merge queue Nov 19, 2024
Merged via the queue into ballerina-platform:master with commit 3571e1d Nov 19, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MaryamZi MaryamZi MaryamZi approved these changes

@NipunaRanasinghe NipunaRanasinghe Awaiting requested review from NipunaRanasinghe NipunaRanasinghe is a code owner

@gimantha gimantha Awaiting requested review from gimantha gimantha is a code owner

@sm1990 sm1990 Awaiting requested review from sm1990

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

documentation: improve the explanation about backtick templates
3 participants
@heshanpadmasiri @sm1990 @MaryamZi