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-32005 Documentation for the hyperlinks testing GitHub Action #18801

Merged
merged 1 commit into from
Jul 17, 2024
Merged

HPCC-32005 Documentation for the hyperlinks testing GitHub Action #18801

merged 1 commit into from
Jul 17, 2024

Conversation

Charan-Sharan
Copy link
Contributor

@Charan-Sharan Charan-Sharan commented Jun 24, 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:

JamesDeFabia
JamesDeFabia requested changes Jun 24, 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 except for the two places with red bars, noted below

.github/workflows/test-hyperlinks.md Outdated
Link_text=$( cat $FILE | grep -oE "\[.*\]\(${REFERENCE}\)" | sed 's/\[//' | cut -d ']' -f1 )
IS_PRESENT=$(cat $FILE | grep -oE "# ${Link_text}" | wc -w)
if [[ $IS_PRESENT -eq 0 ]]; then
echo -e "${LINE} -\u001b[31m invalid reference"
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure what the red bars are here and on line 204. They show on the rendered page as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed those red bars.

@Charan-Sharan Charan-Sharan force-pushed the HPCC-32005-hyperlinks-docs-master branch from 3f24804 to 0107a2a Compare June 25, 2024 01:13
JamesDeFabia
JamesDeFabia approved these changes Jun 25, 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. Nice work

@Charan-Sharan Charan-Sharan force-pushed the HPCC-32005-hyperlinks-docs-master branch from 0107a2a to 5ba919b Compare June 26, 2024 17:13
@Charan-Sharan Charan-Sharan marked this pull request as ready for review June 27, 2024 12:31
AttilaVamos
AttilaVamos approved these changes Jun 27, 2024
View reviewed changes
Copy link
Contributor

@AttilaVamos AttilaVamos left a comment

Choose a reason for hiding this comment

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

Seems good to go.

@GordonSmith
Copy link
Member

@AttilaVamos would devdoc be a better location for this document?

@AttilaVamos
Copy link
Contributor

@GordonSmith let's ask @JamesDeFabia and @stuartort about "would devdoc be a better location for this document?"

@JamesDeFabia
Copy link
Contributor

Since we have other MD files in the \workflow\ folder, I think this is a good place.

@GordonSmith
Copy link
Member

The other ones are used by GitHub for things like the default PR comment etc.?

@JamesDeFabia
Copy link
Contributor

There is one with instructions for Bundle Testing

@Charan-Sharan Charan-Sharan force-pushed the HPCC-32005-hyperlinks-docs-master branch from 5ba919b to bf6a3c8 Compare July 10, 2024 11:05
JamesDeFabia
JamesDeFabia approved these changes Jul 11, 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

AttilaVamos
AttilaVamos approved these changes Jul 16, 2024
View reviewed changes
Copy link
Contributor

@AttilaVamos AttilaVamos left a comment

Choose a reason for hiding this comment

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

Seems good.

@Charan-Sharan Charan-Sharan force-pushed the HPCC-32005-hyperlinks-docs-master branch from bf6a3c8 to eb836b4 Compare July 16, 2024 12:19
@ghalliday ghalliday merged commit 2b4ca28 into hpcc-systems:master Jul 17, 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

@AttilaVamos AttilaVamos AttilaVamos approved these changes

@JamesDeFabia JamesDeFabia JamesDeFabia approved these changes

Assignees

@Charan-Sharan Charan-Sharan

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Charan-Sharan @GordonSmith @AttilaVamos @JamesDeFabia @ghalliday