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

Update documentation for private vulnerability repository #2990

Merged
merged 3 commits into from Aug 30, 2023

Conversation

nscuro
Copy link
Member

@nscuro nscuro commented Aug 27, 2023

Description

This PR updates the documentation for DT's private vulnerability repository feature, as the current documentation is outdated.

It also downgrades jekyll to version 3.9.x again, as GitHub Pages does not yet support Jekyll 4.x yet, according to https://pages.github.com/versions/

Addressed Issue

Fixes #2703

Additional Details

N/A

Checklist

  • I have read and understand the contributing guidelines
  • This PR fixes a defect, and I have provided tests to verify that the fix is effective
  • This PR implements an enhancement, and I have provided tests to verify that it works as intended
  • This PR introduces changes to the database model, and I have added corresponding update logic
  • This PR introduces new or alters existing behavior, and I have updated the documentation accordingly

GitHub Pages does not support Jekyll 4.x yet: https://pages.github.com/versions/

Signed-off-by: nscuro <nscuro@protonmail.com>
Signed-off-by: nscuro <nscuro@protonmail.com>
Fixes DependencyTrack#2703

Signed-off-by: nscuro <nscuro@protonmail.com>
Copy link
Contributor

@leec94 leec94 left a comment

Choose a reason for hiding this comment

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

The images aren't showing, they show up as links. and when clicking the links they result in a 404. Looks like it may be because the images are in a docs folder. If the docs are generated in a different way that might not be an issue. Otherwise, the changes look good, documentation is clear and the images are helpful.

@nscuro
Copy link
Member Author

nscuro commented Aug 28, 2023

Thanks @leec94, appreciate the review! 🙌

The images aren't showing, they show up as links. and when clicking the links they result in a 404. Looks like it may be because the images are in a docs folder. If the docs are generated in a different way that might not be an issue.

Hmmm, did you build the docs? Sadly the markdown sources by themself are almost useless in sites built with Jekyll, mostly due to the linking issues you mentioned :(

Copy link
Contributor

@leec94 leec94 left a comment

Choose a reason for hiding this comment

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

i was able to run jekyll to view the generated docs, and i can see the images. both content and images look great!

@leec94
Copy link
Contributor

leec94 commented Aug 29, 2023

after deleting Gemfile.lock, running ./dev/scripts/docs-dev-docker.sh works to generate the documentation as well.

@nscuro
Copy link
Member Author

nscuro commented Aug 30, 2023

Thanks for the review @leec94!

@nscuro nscuro merged commit 73c0d1b into DependencyTrack:master Aug 30, 2023
9 checks passed
@nscuro nscuro deleted the issue-2703 branch August 30, 2023 17:49
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 30, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update docs for private vulnerability repository
2 participants