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.

Sign up for GitHub

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

Jump to bottom

HPCC-18331 Document wutool info option #18243

Merged
merged 1 commit into from
Feb 2, 2024
Merged

HPCC-18331 Document wutool info option #18243

merged 1 commit into from
Feb 2, 2024

Conversation

g-pan
Copy link
Member

@g-pan g-pan commented Jan 23, 2024

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 integration testing http://10.224.20.18/view/Docs-gp/job/Doc-Build-04-GPRepo2/

@github-actions GitHub Actions
Copy link

https://track.hpccsystems.com/browse/HPCC-18331
Jira updated

JamesDeFabia
JamesDeFabia requested changes Jan 23, 2024
View reviewed changes
Copy link
Contributor

@JamesDeFabia JamesDeFabia left a comment

Choose a reason for hiding this comment

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

A few comments inline

docs/EN_US/HPCCSystemAdmin/SA-Mods/WUTool.xml Outdated
@@ -8,7 +8,7 @@
<primary>wutool</primary>
</indexterm></emphasis><emphasis>action </emphasis><emphasis
role="bold">[WUID=nnn </emphasis><emphasis role="bold">] [ DALISERVER=ip ]
[option=value]</emphasis></para>
[CASSANDRASERVER=ip] [option=value]</emphasis></para>
Copy link
Contributor

Choose a reason for hiding this comment

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

Since we no longer support Cassandra as a System Data Store, this parameter should be removed.
We should also open a Jira to remove it from the WUTOOL usage.

Copy link
Member Author

Choose a reason for hiding this comment

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

correct, this still displays on the wutools' help page. @ghalliday can you please comment

Copy link
Contributor

Choose a reason for hiding this comment

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

I opened a Jira
https://track.hpccsystems.com/browse/HPCC-31177

Copy link
Member Author

Choose a reason for hiding this comment

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

https://track.hpccsystems.com/browse/HPCC-31177

docs/EN_US/HPCCSystemAdmin/SA-Mods/WUTool.xml Outdated
</tgroup>
</informaltable>

<para>If the<emphasis role="bold"> [CASSANDRASERVER=ip]</emphasis> option is
Copy link
Contributor

Choose a reason for hiding this comment

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

Since we no longer support Cassandra as a System Data Store, this whole section should be removed.

docs/EN_US/HPCCSystemAdmin/SA-Mods/WUTool.xml Outdated
</row>

<row>
<entry><emphasis role="white">.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this a kludge to force a space by having a dot in white? How would this work in the future when we support dark mode in HTML?
An alternate way would be to use role="wsig" which forces the text to monospaced font and allows indenting by spaces.

Copy link
Member Author

Choose a reason for hiding this comment

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

should be marked as role="tab" - but point taken nonetheless

@ghalliday
Copy link
Member

@g-pan did you mean to re-request a review from Jim?

@g-pan g-pan requested a review from JamesDeFabia January 25, 2024 23:29
JamesDeFabia
JamesDeFabia approved these changes Jan 26, 2024
View reviewed changes
Copy link
Contributor

@JamesDeFabia JamesDeFabia left a comment

Choose a reason for hiding this comment

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

it is all good from my POV

@g-pan
Copy link
Member Author

g-pan commented Jan 26, 2024

squashed

@ghalliday ghalliday merged commit f9f2678 into hpcc-systems:candidate-9.4.x Feb 2, 2024
48 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JamesDeFabia JamesDeFabia JamesDeFabia approved these changes

@ghalliday ghalliday ghalliday approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@g-pan @ghalliday @JamesDeFabia