You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by "Debraj-80 (via GitHub)" <gi...@apache.org> on 2025/07/31 12:05:50 UTC

[PR] #11312 Issue: Update README.md [cloudstack]

Debraj-80 opened a new pull request, #11362:
URL: https://github.com/apache/cloudstack/pull/11362

   ### Description
   
   This PR **comprehensively refines the `README.md` file to be more engaging, concise, and marketing-oriented**, directly addressing feedback and suggestions.
   
   **Key changes include:**
   -   **Updated Tagline/Overview:** Transformed into a dynamic, benefit-driven statement for immediate impact.
   -   **Enhanced Key Features:** Rewritten as a "Features at a Glance" section with clear, scannable, and benefits-oriented bullet points.
   -   **Improved Quick Start/Try It Now:** Created a "πŸš€ Try CloudStack in Minutes" section with clear, frictionless paths for evaluation (including Docker).
   -   **Detailed Ecosystem & Integrations:** Expanded to highlight key integrations and explain their value.
   -   **Refined Project Maturity & Release Cadence:** Clarified the project's stability, active development, and predictable release cycle.
   -   **Streamlined Getting Involved & Contributing:** Restructured to be more inviting and provide clearer guidance for various types of contributions.
   -   **Polished License & Security:** Consolidated and rephrased for better clarity, professionalism, and accessibility.
   -   **General Markdown Fixes:** Corrected minor formatting issues, spacing, and link syntax throughout the document for cleaner rendering.
   
   This update aims to significantly improve the first impression for new users and contributors, making information more accessible and compelling.
   
   Fixes: #11312
   ### Types of changes
   
   - [ ] Breaking change (fix or feature that would cause existing functionality to change)
   - [ ] New feature (non-breaking change which adds functionality)
   - [ ] Bug fix (non-breaking change which fixes an issue)
   - [X] Enhancement (improves an existing feature and functionality)
   - [X] Cleanup (Code refactoring and cleanup, that may add test cases)
   - [ ] build/CI
   - [ ] test (unit or integration test code)
   
   ### Feature/Enhancement Scale or Bug Severity
   
   #### Feature/Enhancement Scale
   
   - [X] Major
   - [ ] Minor
   
   #### Bug Severity
   
   - [ ] BLOCKER
   - [ ] Critical
   - [ ] Major
   - [ ] Minor
   - [ ] Trivial
   
   ### Screenshots (if appropriate):
   
   *Not applicable for a README.md text update.* (If you had visual changes, like a new screenshot image, you would upload it here).
   
   ### How Has This Been Tested?
   
   The changes are entirely confined to documentation (`README.md`).
   
   * **Local Rendering:** Verified the Markdown renders correctly using a local Markdown previewer (e.g., in VS Code).
   * **Link Validation:** All external and internal links within the `README.md` have been checked for correctness and accessibility.
   * **Content Review:** The text has been thoroughly reviewed for clarity, conciseness, grammar, and alignment with the project's updated messaging goals.
   
   #### How did you try to break this feature and the system with this change?
   
   As a documentation-only change, this PR does not introduce functional changes to the software system. Testing focused on ensuring the document itself is well-formatted, accurate, and enhances user experience, without any negative side effects on readability or information access.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] #11312 Issue: Update README.md [cloudstack]

Posted by "Debraj-80 (via GitHub)" <gi...@apache.org>.
Debraj-80 closed pull request #11362: #11312 Issue: Update README.md
URL: https://github.com/apache/cloudstack/pull/11362


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] #11312 Issue: Update README.md [cloudstack]

Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #11362:
URL: https://github.com/apache/cloudstack/pull/11362#issuecomment-3139697922

   Congratulations on your first Pull Request and welcome to the Apache CloudStack community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/cloudstack/blob/main/CONTRIBUTING.md)
   Here are some useful points:
   - In case of a new feature add useful documentation (raise doc PR at https://github.com/apache/cloudstack-documentation)
   - Be patient and persistent. It might take some time to get a review or get the final approval from the committers.
   - Pay attention to the quality of your code, ensure tests are passing and your PR doesn't have conflicts.
   - Please follow [ASF Code of Conduct](https://github.com/apache/.github/blob/main/.github/CODE_OF_CONDUCT.md) for all communication including (but not limited to) comments on Pull Requests, Issues, Mailing list and Slack.
   - Be sure to read the [CloudStack Coding Conventions](https://cwiki.apache.org/confluence/display/CLOUDSTACK/Coding+conventions).
   Apache CloudStack is a community-driven project and together we are making it better πŸš€.
   In case of doubts contact the developers at:
   Mailing List: dev@cloudstack.apache.org (https://cloudstack.apache.org/mailing-lists.html)
   Slack: https://apachecloudstack.slack.com/
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] #11312 Issue: Update README.md [cloudstack]

Posted by "codecov[bot] (via GitHub)" <gi...@apache.org>.
codecov[bot] commented on PR #11362:
URL: https://github.com/apache/cloudstack/pull/11362#issuecomment-3139955400

   ## [Codecov](https://app.codecov.io/gh/apache/cloudstack/pull/11362?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
   :white_check_mark: All modified and coverable lines are covered by tests.
   :white_check_mark: Project coverage is 3.65%. Comparing base ([`1f1e38f`](https://app.codecov.io/gh/apache/cloudstack/commit/1f1e38f3a85f6bfe3e941c88671e36878a971fda?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)) to head ([`0d305fb`](https://app.codecov.io/gh/apache/cloudstack/commit/0d305fb656c948ede60bb0d19cd91c015ee46bae?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)).
   :warning: Report is 15 commits behind head on main.
   > :exclamation:  There is a different number of reports uploaded between BASE (1f1e38f) and HEAD (0d305fb). Click for more details.
   > 
   > <details><summary>HEAD has 1 upload less than BASE</summary>
   >
   >| Flag | BASE (1f1e38f) | HEAD (0d305fb) |
   >|------|------|------|
   >|unittests|1|0|
   ></details>
   
   <details><summary>Additional details and impacted files</summary>
   
   
   
   ```diff
   @@              Coverage Diff              @@
   ##               main   #11362       +/-   ##
   =============================================
   - Coverage     17.17%    3.65%   -13.53%     
   =============================================
     Files          5869      441     -5428     
     Lines        521732    36816   -484916     
     Branches      63511     6736    -56775     
   =============================================
   - Hits          89611     1344    -88267     
   + Misses       422064    35312   -386752     
   + Partials      10057      160     -9897     
   ```
   
   | [Flag](https://app.codecov.io/gh/apache/cloudstack/pull/11362/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Coverage Ξ” | |
   |---|---|---|
   | [uitests](https://app.codecov.io/gh/apache/cloudstack/pull/11362/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `3.65% <ΓΈ> (-0.11%)` | :arrow_down: |
   | [unittests](https://app.codecov.io/gh/apache/cloudstack/pull/11362/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `?` | |
   
   Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#carryforward-flags-in-the-pull-request-comment) to find out more.
   </details>
   
   [:umbrella: View full report in Codecov by Sentry](https://app.codecov.io/gh/apache/cloudstack/pull/11362?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).   
   :loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
   <details><summary> :rocket: New features to boost your workflow: </summary>
   
   - :snowflake: [Test Analytics](https://docs.codecov.com/docs/test-analytics): Detect flaky tests, report on failures, and find test suite problems.
   - :package: [JS Bundle Analysis](https://docs.codecov.com/docs/javascript-bundle-analysis): Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
   </details>


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org