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

Added more examples to testing type descriptions #1970

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from

Conversation

shbenzer
Copy link
Contributor

@shbenzer shbenzer commented Sep 24, 2024

User description

added more examples to testing type descriptions

Description

added examples to stress, load, and regression testing

Motivation and Context

increase understanding for new qa testers reading docs

Types of changes

  • Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • I have read the contributing document.
  • I have used hugo to render the site/docs locally and I am sure it works.

PR Type

Documentation


Description

  • Added examples to the documentation for load, stress, and regression testing in multiple languages.
  • Enhanced the understanding of testing types for new QA testers.
  • Improved documentation across English, Japanese, Portuguese (Brazil), and Chinese languages.

Changes walkthrough 📝

Relevant files
Documentation
testing_types.en.md
Add examples to testing types documentation in English     

website_and_docs/content/documentation/test_practices/testing_types.en.md

  • Added examples for load, stress, and regression testing.
  • Enhanced documentation for better understanding.
  • +6/-0     
    testing_types.ja.md
    Add examples to testing types documentation in Japanese   

    website_and_docs/content/documentation/test_practices/testing_types.ja.md

  • Added examples for load, stress, and regression testing.
  • Enhanced documentation for Japanese readers.
  • +6/-0     
    testing_types.pt-br.md
    Add examples to testing types documentation in Portuguese (Brazil)

    website_and_docs/content/documentation/test_practices/testing_types.pt-br.md

  • Added examples for load, stress, and regression testing.
  • Enhanced documentation for Portuguese (Brazil) readers.
  • +6/-0     
    testing_types.zh-cn.md
    Add examples to testing types documentation in Chinese     

    website_and_docs/content/documentation/test_practices/testing_types.zh-cn.md

  • Added examples for load, stress, and regression testing.
  • Enhanced documentation for Chinese readers.
  • +6/-0     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link

    netlify bot commented Sep 24, 2024

    👷 Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    🔨 Latest commit 2b768ff

    @codiumai-pr-agent-pro codiumai-pr-agent-pro bot added the documentation Improvements or additions to documentation label Sep 24, 2024
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Key issues to review

    Inconsistent Language
    The added examples are in English for all language versions of the document, which may confuse non-English readers.

    Untranslated Content
    The new examples are not translated into Japanese, which may reduce their effectiveness for Japanese readers.

    Untranslated Content
    The new examples are not translated into Portuguese, which may reduce their effectiveness for Brazilian Portuguese readers.

    Untranslated Content
    The new examples are not translated into Chinese, which may reduce their effectiveness for Chinese readers.

    Copy link
    Contributor

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Translate examples to all supported languages for consistency

    Translate the example for load testing into Japanese, Portuguese, and Chinese to
    maintain consistency across all language versions of the documentation.

    website_and_docs/content/documentation/test_practices/testing_types.en.md [66]

     >For example,  **_Testing that the site can handle numerous orders/users at once._**
     
    +>例えば、**_サイトが一度に多数の注文/ユーザーを処理できることをテストする。_**
    +
    +>Por exemplo, **_Testar se o site pode lidar com vários pedidos/usuários de uma só vez._**
    +
    +>例如,**_测试网站是否能同时处理大量订单/用户。_**
    +
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: Translating examples into all supported languages enhances consistency and accessibility across the documentation, making it easier for non-English speakers to understand the examples.

    9
    Translate examples into Japanese for better comprehension by Japanese readers

    Translate the examples for load testing, stress testing, and regression testing into
    Japanese to maintain consistency with the English version and improve readability
    for Japanese users.

    website_and_docs/content/documentation/test_practices/testing_types.ja.md [45-70]

    ->For example,  **_Testing that the site can handle numerous orders/users at once._**
    +>例えば、**_サイトが一度に多数の注文/ユーザーを処理できることをテストする。_**
     
    ->For example,  **_Testing that your ecommerce site can handle Black Friday_**
    +>例えば、**_eコマースサイトがブラックフライデーに対応できることをテストする。_**
     
    ->For example,  **_Testing that your new search bar doesn't break the other buttons on the menu_**
    +>例えば、**_新しい検索バーが、メニューの他のボタンを壊していないことをテストする。_**
     
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: Translating examples into Japanese ensures that Japanese readers can fully comprehend the documentation, aligning with the multilingual support provided in the PR.

    9
    Provide multiple examples for regression testing to illustrate its scope

    Expand the regression testing example to include multiple scenarios, showcasing the
    breadth of regression testing.

    website_and_docs/content/documentation/test_practices/testing_types.en.md [97]

    ->For example,  **_Testing that your new search bar doesn't break the other buttons on the menu_**
    +>For example:
    +>- **_Testing that your new search bar doesn't break the other buttons on the menu_**
    +>- **_Verifying that existing user authentication still works after implementing a new password policy_**
    +>- **_Ensuring that previously working features like shopping cart and payment processing are unaffected by recent database optimizations_**
     
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    Why: Expanding the regression testing example to include multiple scenarios offers a broader understanding of the scope and importance of regression testing, enhancing the educational value of the documentation.

    8
    Provide a more specific example for stress testing

    Provide a more specific example for stress testing, focusing on a particular aspect
    of the system under extreme load.

    website_and_docs/content/documentation/test_practices/testing_types.en.md [72]

    ->For example,  **_Testing that your ecommerce site can handle Black Friday_**
    +>For example,  **_Testing that your ecommerce site's checkout process remains functional when experiencing 10 times the normal traffic during a Black Friday sale_**
     
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: Providing a more specific example for stress testing improves clarity and helps readers better understand the practical implications of stress testing in real-world scenarios.

    7

    💡 Need additional feedback ? start a PR chat

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    documentation Improvements or additions to documentation Review effort [1-5]: 2
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant