Skip to content

IGNITE-28640 Fix broken and outdated links in Apache Ignite 2.x documentation#13087

Open
ignitetcbot wants to merge 3 commits intoapache:masterfrom
ignitetcbot:ignite-28593
Open

IGNITE-28640 Fix broken and outdated links in Apache Ignite 2.x documentation#13087
ignitetcbot wants to merge 3 commits intoapache:masterfrom
ignitetcbot:ignite-28593

Conversation

@ignitetcbot
Copy link
Copy Markdown

Thank you for submitting the pull request to the Apache Ignite.

In order to streamline the review of the contribution
we ask you to ensure the following steps have been taken:

The Contribution Checklist

  • 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 pull request body describes changes that have been made.
    The description explains WHAT and WHY was made instead of 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.
  • A reviewer has been mentioned through the JIRA comments
    (see the Maintainers list)
  • The pull request has been checked by the Teamcity Bot and
    the green visa attached to the JIRA ticket (see tab PR Check at TC.Bot - Instance 1 or TC.Bot - Instance 2)

Notes

If you need any help, please email dev@ignite.apache.org or ask anу advice on http://asf.slack.com #ignite channel.

Comment thread docs/_data/toc.yaml
url: sql-reference/dml
- title: Transactions
url: sql-reference/transactions
url: key-value-api/transactions
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the only suspricious item, we seems don't have an SQL reference for transactions in adoc?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Found that we were missing this section for couple of releases.

To be documented as a part of standalone issue

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 4, 2026

TODO:
You can implement a custom affinity function if you want to control the way data is distributed in the cluster.
See the link:advanced-topics/affinity-function[Affinity Function] section in Advanced Topics.
See the link:data-modeling/data-partitioning#affinity-function[Affinity Function] section.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this section is not visible, seems we need to fix it ?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

That's fine here that section is hidden. Practically those who would like to implement such advanced functions as a custom affinity could read cwiki.apache.org and/or java code and javadocs

In the cases where you do not need to colocate computations with data but simply want to process all data remotely, you can run local cache queries inside the `call()` method. Consider the following example.
Let's say we have a cache that stores information about persons and we want to calculate the average age of all persons. One way to accomplish this is to run a link:key-value-api/querying[scan query] that will fetch the ages of all persons to the local node, where you can calculate the average age.
Let's say we have a cache that stores information about persons and we want to calculate the average age of all persons. One way to accomplish this is to run a link:key-value-api/using-cache-queries[scan query] that will fetch the ages of all persons to the local node, where you can calculate the average age.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this section is totally not visible, need to fix

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Compute.broadcast() with ScanQuery.setLocal(true) is really good opportunity of the product, so I agree, I've created https://issues.apache.org/jira/browse/IGNITE-28641 for this change

Management task events represent the tasks that are executed by Visor or Web Console.
This event type can be used to monitor a link:security/cluster-monitor-audit[Web Console activity].
This event type can be used to monitor Web Console activity.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

not visible

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Looks like we can keep it outcommented or remove from the end user doc.

Comment thread docs/_data/toc.yaml
- title: Azure Kubernetes Service
url: installation/kubernetes/azure-deployment
- title: Google Kubernetes Engine
url: installation/kubernetes/gke-deployment
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

generic-configuration.adoc also need to be added

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

I don’t think we should restore generic-configuration.adoc this as-is.

This page is already marked published: false, targets an outdated Kubernetes setup (kubectl 1.17), and mostly duplicates generic deployment steps that are better covered by Helm/operator-based approaches today. Keeping it would add maintenance burden and risk misleading users.

Comment thread docs/_docs/quick-start/cpp.adoc Outdated
to Ignite clusters
* Explore the link:{githubUrl}/modules/platforms/cpp/examples[additional C++ examples] included with Ignite
* Refer to the link:cpp-specific[C{plus}{plus} specific section] of the documentation to learn more about capabilities
* Refer to the link:cpp-specific/index[C{plus}{plus} specific section] of the documentation to learn more about capabilities
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

seems this section still empty and not highlights corresponding item, looks like an UI problem for me.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Changed to /docs/cpp-specific/cpp-serialization as the first page in the section

[NOTE]
====
Setting 'STREAMING ON' uses link:../data-streaming.adoc#_limitations[DataStreamer] which doesn't guarantee by default data consistency until successfully finished.
Setting 'STREAMING ON' uses link:data-streaming#_limitations[DataStreamer] which doesn't guarantee by default data consistency until successfully finished.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

i see no "_limitations" anchor probably you mean "limitations" ?


== Executing SQL Statements
The Node.js thin client supports all link:sql-reference[SQL commands] that are supported by Ignite.
The Node.js thin client supports all link:sql-reference/index[SQL commands] that are supported by Ignite.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

empty page, not UI friendly i suppose

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Changed to /docs/sql-reference/sql-conformance as thirst first page in the section


== Executing SQL Statements
The PHP thin client supports all link:sql-reference[SQL commands] that are supported by Ignite.
The PHP thin client supports all link:sql-reference/index[SQL commands] that are supported by Ignite.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the same as above

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

updated, the same as above

@ignitetcbot ignitetcbot changed the title IGNITE-28593: Doc links fixes IGNITE-28640 Fix broken and outdated links in Apache Ignite 2.x documentation May 4, 2026
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