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

refactor: use version-specific URLs for documentation references #6966

Merged
merged 3 commits into from
Jun 20, 2024

Conversation

knqyf263
Copy link
Collaborator

Description

In the codebase, there are instances where documentation is referenced using URLs like https://aquasecurity.github.io/trivy/latest/. However, since the content of the documentation can change with each version, it is preferable to display the URL that matches the version being used.

For example, if Trivy v0.52.0 is being used, the URL https://aquasecurity.github.io/trivy/v0.52/ should be displayed instead.

By implementing the common package, we ensure that the correct version-specific documentation URL is used consistently throughout the codebase.

Checklist

  • I've read the guidelines for contributing to this repository.
  • I've followed the conventions in the PR title.
  • I've added tests that prove my fix is effective or that my feature works.
  • I've updated the documentation with the relevant information (if needed).
  • I've added usage information (if the PR introduces new options)
  • I've included a "before" and "after" example to the description (if the PR is a user interface change).

Signed-off-by: knqyf263 <knqyf263@gmail.com>
@knqyf263 knqyf263 self-assigned this Jun 19, 2024
knqyf263 added 2 commits June 20, 2024 06:30
Signed-off-by: knqyf263 <knqyf263@gmail.com>
Signed-off-by: knqyf263 <knqyf263@gmail.com>
@knqyf263 knqyf263 requested a review from DmitriyLewen June 20, 2024 06:58
Copy link
Contributor

@DmitriyLewen DmitriyLewen left a comment

Choose a reason for hiding this comment

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

LGTM

@knqyf263 knqyf263 added this pull request to the merge queue Jun 20, 2024
Merged via the queue into aquasecurity:main with commit 30bcb95 Jun 20, 2024
12 checks passed
@knqyf263 knqyf263 deleted the refactor/versioned_docs branch June 20, 2024 10:59
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