Skip to content

Conversation

DaltheCow
Copy link
Collaborator

@DaltheCow DaltheCow commented May 21, 2025

We are getting link-check fails on the github rich display links. Not sure what the desired solution is but this gets the check passing by ignoring links like that.

Also we have what look to be some pasted doc remnants from the speculators repo so I changed everything saying speculators to guidellm

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15169433787/artifacts/3171044116.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15169751247/artifacts/3171167025.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15170947437/artifacts/3171613367.
They will be retained for up to 30 days.

@DaltheCow DaltheCow changed the title remove speculators from docs fix links check fail, remove speculators from docs May 21, 2025
sjmonson
sjmonson previously approved these changes May 21, 2025
Copy link
Collaborator

@markurtz markurtz left a comment

Choose a reason for hiding this comment

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

Thanks @DaltheCow! The big issue that is happening behind the scenes is that we're getting rate-limited by GitHub on checks, and the link checking software doesn't have any ability for us to apply a rate limit to it (in combination with GitHub not returning proper wait until headers). So I was going to migrate to a new tool that we could control, which would also pass in GitHub auth credentials to increase the potential rate at which we can hit GitHub. For now, though, the updates to the links are good catches, and if we can update it to just wipe out the link checks until we can get the new tool in, that would be perfect. I'd rather wipe out the tool than hardcode skipping of all GitHub links, so we don't have a false sense of security reported, since most of the links will be GitHub ones. I can update a bit later, but if you can get to it, that would be perfect and I can rereview

@DaltheCow
Copy link
Collaborator Author

Thanks @DaltheCow! The big issue that is happening behind the scenes is that we're getting rate-limited by GitHub on checks, and the link checking software doesn't have any ability for us to apply a rate limit to it (in combination with GitHub not returning proper wait until headers). So I was going to migrate to a new tool that we could control, which would also pass in GitHub auth credentials to increase the potential rate at which we can hit GitHub. For now, though, the updates to the links are good catches, and if we can update it to just wipe out the link checks until we can get the new tool in, that would be perfect. I'd rather wipe out the tool than hardcode skipping of all GitHub links, so we don't have a false sense of security reported, since most of the links will be GitHub ones. I can update a bit later, but if you can get to it, that would be perfect and I can rereview

Sounds good! Will do that

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15190575856/artifacts/3178271030.
They will be retained for up to 30 days.

@DaltheCow
Copy link
Collaborator Author

I removed it from the development and main workflows and left it in the others, thinking we might want to leave those as failing until this can be resolved.

@sjmonson sjmonson self-requested a review May 22, 2025 19:54
@markurtz markurtz merged commit 6fff1bf into main May 27, 2025
10 checks passed
@markurtz markurtz deleted the update-docs branch May 27, 2025 14:04
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