Skip to content

Conversation

@JAkutenshi
Copy link
Contributor

JIRA Ticket: IGNITE-23221

The goal

The main goal is to remove obsolete links on Apache Ignite documentation website.

The reason

We should use proper up-to-date documentation warning messages for our users.

The solution

The only place that contains a link with the noticed prefix https://apacheignite.readme.io/ is JAVA_VER_WARN variable that is used for user's notification about Java version specific startup parameters. But for now we're supporting only Java 11+, so at most the message is obsolete and we should to inform a user about proper JVM's startup parameters with a link on a proper documentation about Ignite startup but 3.0.0-beta version until release: https://ignite.apache.org/docs/3.0.0-beta/quick-start/getting-started-guide

Also the constant itself was renamed accordingly.


Thank you for submitting the pull request.

To streamline the review process of the patch and ensure better code quality
we ask both an author and a reviewer to verify the following:

The Review Checklist

  • Formal criteria: TC status, codestyle, mandatory documentation. Also make sure to complete the following:
    - There is a single JIRA ticket related to the pull request.
    - The web-link to the pull request is attached to the JIRA ticket.
    - The JIRA ticket has the Patch Available state.
    - The description of the JIRA ticket explains WHAT was made, WHY and HOW.
    - The pull request title is treated as the final commit message. The following pattern must be used: IGNITE-XXXX Change summary where XXXX - number of JIRA issue.
  • Design: new code conforms with the design principles of the components it is added to.
  • Patch quality: patch cannot be split into smaller pieces, its size must be reasonable.
  • Code quality: code is clean and readable, necessary developer documentation is added if needed.
  • Tests code quality: test set covers positive/negative scenarios, happy/edge cases. Tests are effective in terms of execution time and resources.

Notes

@sk0x50 sk0x50 merged commit 55a3e70 into apache:main Sep 17, 2024
@sk0x50 sk0x50 deleted the ignite-23221 branch September 17, 2024 13:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants