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-32018 Restore User documentation for Z.A.P. #19211

Merged
merged 1 commit into from
Nov 1, 2024
Merged

HPCC-32018 Restore User documentation for Z.A.P. #19211

merged 1 commit into from
Nov 1, 2024

Conversation

g-pan
Copy link
Member

@g-pan g-pan commented Oct 18, 2024 •
edited
Loading

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:

https://github.com/g-pan/github-action-dev-build/actions/runs/11404875227

@g-pan g-pan requested a review from JamesDeFabia October 18, 2024 13:45
@github-actions GitHub Actions
Copy link

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

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

@g-pan
Copy link
Member Author

g-pan commented Oct 18, 2024

Bad Testing Link : Please see the testing results here: https://github.com/g-pan/github-action-dev-build/actions/runs/11405455193

JamesDeFabia
JamesDeFabia requested changes Oct 21, 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.

Comments inline

docs/EN_US/Installing_and_RunningTheHPCCPlatform/Inst-Mods/ZAP.xml Outdated
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<book>
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this included module need to be a ? It seems like this contains a significant amount of superfluous content.

docs/EN_US/Installing_and_RunningTheHPCCPlatform/Inst-Mods/ZAP.xml Outdated
<para>Some of the required fields are populated. Fill in the
corresponding values under Description, History, and Timings fields.
Optionally, you can password protect the ZAP package and choose to
include slave logs. Slave logs are not included by default. If there
Copy link
Contributor

Choose a reason for hiding this comment

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

Should not use the deprecated term. I believe the interface names have been corrected to avoid offensive terms.

@g-pan g-pan requested a review from JamesDeFabia October 23, 2024 18:47
JamesDeFabia
JamesDeFabia approved these changes Oct 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.

Looks good from my POV

@ghalliday ghalliday merged commit 6c01782 into hpcc-systems:master Nov 1, 2024
49 of 50 checks passed
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 1, 2024

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

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

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 @JamesDeFabia @ghalliday