HPCC-33102 Fix Broken Links in HPCCClient Tools Doc

[g-pan]

Type of change:

• This change is a bug fix (non-breaking change which fixes an issue).
• This change is a new feature (non-breaking change which adds functionality).
• This change improves the code (refactor or other change that does not change the functionality)
• This change fixes warnings (the fix does not alter the functionality or the generated code)
• This change is a breaking change (fix or feature that will cause existing behavior to change).
• This change alters the query API (existing queries will have to be recompiled)

Checklist:

• My code follows the code style of this project.
  • My code does not create any new warnings from compiler, build system, or lint.
• The commit message is properly formatted and free of typos.
  • The commit message title makes sense in a changelog, by itself.
  • The commit is signed.
• My change requires a change to the documentation.
  • I have updated the documentation accordingly, or...
  • I have created a JIRA ticket to update the documentation.
  • Any new interfaces or exported functions are appropriately commented.
• I have read the CONTRIBUTORS document.
• The change has been fully tested:
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have checked that this change does not introduce memory leaks.
  • I have used Valgrind or similar tools to check for potential issues.
• I have given due consideration to all of the following potential concerns:
  • Scalability
  • Performance
  • Security
  • Thread-safety
  • Cloud-compatibility
  • Premature optimization
  • Existing deployed queries will not be broken
  • This change fixes the problem, not just the symptom
  • The target branch of this pull request is appropriate for such a change.
• There are no similar instances of the same problem that should be addressed
  • I have addressed them here
  • I have raised JIRA issues to address them separately
• This is a user interface / front-end modification
  • I have tested my changes in multiple modern browsers
  • The component(s) render as expected

Smoketest:

• Send notifications about my Pull Request position in Smoketest queue.
• Test my draft Pull Request.

Testing:

Successful unit Testing: https://github.com/g-pan/github-action-dev-build/actions/runs/12931333401

[github-actions]

Jira Issue: https://hpccsystems.atlassian.net//browse/HPCC-33102

Jirabot Action Result:
Workflow Transition To: Merge Pending
Updated PR

[g-pan]

Note 2 files (EN_US: spark and jdbc) were touched by the newer XML Editor - without substantial change

[JamesDeFabia]

Looks good to me

[jakesmith]

@g-pan - it's very hard to see what the actual broken link changes are here, vs all the format changes..

It would really be better to keep this as 2 commits, 1 with the format changes, 1 with the broken link fixes.

[g-pan]

@g-pan - it's very hard to see what the actual broken link changes are here, vs all the format changes..

It would really be better to keep this as 2 commits, 1 with the format changes, 1 with the broken link fixes.

Agreed, and I apologize for the inconvenience -- I provided specifics offline --
We've recently synchronized our XML Editors to write out consistent XML - and due to that when we 'touch' a file in the editor will make a one time reformat of that XML Data
as these files had not been touched by the new editor - there were widespread changes (XML optimization?) to code that should all be disregarded.

Following up on my comment (disregard the Spark & jdbc files) There are only 5 changed Files to review.

CT Overview - line 113

CT Overview without_IDE - line 106, and 170

PT_BR PrG creating example data - line 12

PT_BR CT Overview - lines 128
PT BR CT Overview without IDE 119 & 184

[jakesmith]

@g-pan - looks fine approved.

Maybe all files are now reformatted so that this won't be an issue going forward (?) - but if not, it would be better to 'touch' the file causing a reformat, perform a git commit, then make the relevant PR changes, then create a 2nd git commit, and push the branch for review.
i.e. the PR will have 2 commits, where it is easy to see what the intended actual changes are in the 2nd commit.

[g-pan]

that was an option we discussed - just touching all files and checking them in as one big commit to just reformat everything and avoid the issue going forward - just go through the pain once to have cleaner commits - I apologize for the inconvenience - should we see another case like this it makes sense at least to break it into two commits

[jakesmith]

@g-pan - can you comment on the "Test Hyperlinks" failure?

[g-pan]

the broken links are what this (and the couple other) pull requests are trying to address.
diving into the details Broken links reported here:

1. docs/EN_US/HPCCSpark/SparkHPCC.xml
   Line 110 : https://github.com/hpcc-systems/Spark-HPCC/blob/master/Examples/src/main/ecl/IrisDS.ecl
2. docs/EN_US/JDBC-driver/hpcc-jdbc-driver.xml
   Line 159 : http://hpccsystems.com/permlink/wssql

Are addressed in HPCC-33104 - #19449
also merge pending

So this is actually encouraging as it is expected to be resolved when 19449 is merged.

[github-actions]

Jirabot Action Result:
Added fix version: 9.10.4
Workflow Transition: 'Resolve issue'