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

chore: add html validation to build process #1659

Merged
merged 20 commits into from
Sep 11, 2024
Merged

Conversation

butler54
Copy link
Collaborator

Signed-off-by: Chris Butler [email protected]

Types of changes

  • Hot fix (emergency fix and release)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation (change which affects the documentation site)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Release (develop -> main)

Quality assurance (all should be covered).

  • My code follows the code style of this project.
  • Documentation for my change is up to date?
  • My PR meets testing requirements.
  • All new and existing tests passed.
  • All commits are signed-off.

Summary

Adds validation fo HTML to ensure no dead links exist in the docs site.

Key links:

Before you merge

  • Ensure it is a 'squash commit' if not a release.
  • Ensure CI is currently passing
  • Check sonar. If you are working for a fork a maintainer will reach out, if required.

@butler54 butler54 changed the title chore: Add html validation to build process chore: add html validation to build process Aug 17, 2024
@butler54 butler54 marked this pull request as draft August 17, 2024 05:07
@butler54 butler54 marked this pull request as ready for review August 17, 2024 05:08
@butler54
Copy link
Collaborator Author

Okay this is good to go. All dead links are stripped @jpower432

Copy link
Member

@jpower432 jpower432 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. One suggestion on a link change.

Signed-off-by: Chris Butler <[email protected]>
Copy link
Collaborator

@degenaro degenaro left a comment

Choose a reason for hiding this comment

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

Nice! Looks like you uncovered some broken links. I'm flagging as request changes for now, modulo a final decision on the IBM ssp-demo link.

@degenaro
Copy link
Collaborator

degenaro commented Sep 8, 2024

In #1688 I note that I asked JJ to move the repo. I think it will happen pretty quickly. I suggest updating the link in this PR.

@butler54
Copy link
Collaborator Author

butler54 commented Sep 9, 2024

In #1688 I note that I asked JJ to move the repo. I think it will happen pretty quickly. I suggest updating the link in this PR.

@degenaro the problem is now I can't. The URLs must be valid or the build will fail.

@butler54 butler54 mentioned this pull request Sep 9, 2024
11 tasks
@butler54 butler54 enabled auto-merge (squash) September 10, 2024 02:53
@butler54
Copy link
Collaborator Author

Good to go now

Copy link
Collaborator

@vikas-agarwal76 vikas-agarwal76 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@degenaro degenaro left a comment

Choose a reason for hiding this comment

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

LGTM

@butler54 butler54 merged commit 810f4e7 into develop Sep 11, 2024
14 checks passed
@butler54 butler54 deleted the chore/validate-docs branch September 11, 2024 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants