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.

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

HPCC-32110-1 Fixing issue with sec3, sect2, programlisting in PT_BR docs #18806

Merged

Conversation

Michael-Gardner
Copy link
Contributor

@Michael-Gardner Michael-Gardner commented Jun 24, 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:

Test Build: https://github.com/Michael-Gardner/HPCC-Platform/actions/runs/9651366413/job/26619059050

Copy link

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

Jirabot Action Result:
Workflow Transition: Merge Pending
Additional PR: #18806
Changing assignee from: [email protected] to: [email protected]

@Michael-Gardner
Copy link
Contributor Author

@JamesDeFabia I think you're right about the diff we handed off to the Portuguese translation team being too large. This section that includes YAML_Filestruct-Placement needs to be looked at. It likely completely duplicates the section it had an id conflict with. But I don't speak Portuguese and I don't know how Greg wants to have the final book look like, so I made some minor changes and got rid of a smaller ENV duplicate section so the tags would line up properly for a build.

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. I recognized enough to confirm that is was duplicated text.

@@ -1034,7 +1034,7 @@
<para><ulink
url="https://github.com/hpcc-systems/HPCC-Platform/blob/master/helm/hpcc/docs/placements.md">https://github.com/hpcc-systems/HPCC-Platform/blob/master/helm/hpcc/docs/placements.md</ulink></para>

<sect4 id="YAML_FileStruct_Placement">
<sect4 id="YAML_FileStruct-Placement">
Copy link
Member

Choose a reason for hiding this comment

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

I think this should be sect3, and line 1098 should be /sect3.
If it builds I won't worry though..

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It builds. I'm rather certain that entire ... is a duplicate that should be removed. But I'm not certain exactly what parts of it should be removed, which one is the correct one, etc. Greg made a lot of changes to that specific file and I think the people doing the translation were confused when they saw the diff.

@stuartort stuartort requested a review from g-pan June 25, 2024 13:30
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.

Approving so that 9.6.x can be built.

@ghalliday
Copy link
Member

@g-pan I suspect this still isn't the correct fix because the section levels do not nest correctly.

@ghalliday ghalliday merged commit c5b3595 into hpcc-systems:candidate-9.6.x Jun 25, 2024
50 checks passed
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