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-32398 update doc references to system requirements #19040

Merged
merged 1 commit into from
Sep 20, 2024
Merged

HPCC-32398 update doc references to system requirements #19040

merged 1 commit into from
Sep 20, 2024

Conversation

g-pan
Copy link
Member

@g-pan g-pan commented Aug 26, 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:

successful unit tests: https://github.com/g-pan/github-action-dev-build/actions/runs/10563261305

@g-pan g-pan requested a review from JamesDeFabia August 26, 2024 17:51
@github-actions GitHub Actions
Copy link

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

Jirabot Action Result:
Workflow Transition To: Merge Pending
Additional PR: #19040

JamesDeFabia
JamesDeFabia approved these changes Aug 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.

Good from my POV

ghalliday
ghalliday reviewed Aug 30, 2024
View reviewed changes
Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

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

A couple of comments/questions.

docs/PT_BR/HPCCSystemAdmin/HPCCSystemAdministratorsGuide.xml
@@ -442,7 +442,7 @@
for implementar ou dimensionar seu HPCC System. As sugestões devem ser
levadas em conta de acordo com as suas necessidades empresariais
específicas.</para>

<!-- COMMENTING FOR TEST - THIS WHOLE SECTION SHOULD BE REMOVED.
Copy link
Member

Choose a reason for hiding this comment

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

Should this be removed before merging?

Copy link
Member Author

Choose a reason for hiding this comment

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

it should, but it needs to be replaced with the Portuguese content, to help ensure changes are made properly

Copy link
Member

Choose a reason for hiding this comment

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

ok. If so, it would be worth including that reason in the comment.

docs/EN_US/HPCCSystemAdmin/HPCCSystemAdministratorsGuide.xml Outdated
xpointer="xpointer(//*[@id='Nodes-Software'])"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>
<para>This chapter provides an overview of the hardware and software requirements for running HPCC Systems optimally. While these requirements were significant when HPCC Systems was first deployed many years ago, there have been substantial improvements in hardware since then. The platform now supports virtual containers and cloud deployments, making the requirements less significant even for large-scale (petabytes) bare-metal deployments. In fact, HPCC Systems should perform satisfactorily on most modern hardware configurations.</para>
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't this be "the HPCC Systems platform" rather than "HPCC Systems". Occurs multiple times.

Copy link
Member Author

Choose a reason for hiding this comment

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

yes, good catch

JamesDeFabia
JamesDeFabia approved these changes Sep 3, 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. @g-pan Once this is merged, please follow up with Brazil team.

ghalliday
ghalliday approved these changes Sep 10, 2024
View reviewed changes
Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

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

Please squash

docs/PT_BR/HPCCSystemAdmin/HPCCSystemAdministratorsGuide.xml
@@ -442,7 +442,7 @@
for implementar ou dimensionar seu HPCC System. As sugestões devem ser
levadas em conta de acordo com as suas necessidades empresariais
específicas.</para>

<!-- COMMENTING FOR TEST - THIS WHOLE SECTION SHOULD BE REMOVED.
Copy link
Member

Choose a reason for hiding this comment

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

ok. If so, it would be worth including that reason in the comment.

@ghalliday ghalliday merged commit 52a3223 into hpcc-systems:candidate-9.8.x Sep 20, 2024
49 of 50 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