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-32487 Update links to Code Generator Documentation #19036

Merged
merged 1 commit into from
Sep 25, 2024

Conversation

g-pan
Copy link
Member

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

verified the link

@g-pan g-pan requested a review from ghalliday August 22, 2024 20:20
Copy link

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

Jirabot Action Result:
Workflow Transition: Merge Pending
Updated PR

@ghalliday
Copy link
Member

@g-pan could you have used a relative link, rather than a full link? I will merge as-is anyway.

@ghalliday
Copy link
Member

Also, commit doesn't message does not really provide enough information for a change log. e.g.

Update links to Code Generator Documentation.

Please can you update.

@g-pan g-pan changed the title HPCC-32487 Update Code Generator Links HPCC-32487 Update Code Generator Links in readme files Aug 23, 2024
@g-pan
Copy link
Member Author

g-pan commented Aug 23, 2024

@g-pan could you have used a relative link, rather than a full link? I will merge as-is anyway.

probably - they were relative previously - less likely the full URL will change/fail than a relative link as long as the target URL does not change - was my reasoning.

@g-pan g-pan changed the title HPCC-32487 Update Code Generator Links in readme files HPCC-32487 Update links to Code Generator Documentation Aug 27, 2024
@ghalliday
Copy link
Member

@GordonSmith do we recommend using absolute or relative links?

@GordonSmith
Copy link
Member

Normally relative is preferable, but these are rst files so not sure how GH treats them...

@ghalliday ghalliday merged commit 1c0c9a2 into hpcc-systems:master Sep 25, 2024
51 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