-
Notifications
You must be signed in to change notification settings - Fork 493
Documentation - Hadolint Integrations - Outdated information #1119
Copy link
Copy link
Open
Labels
Description
Hello @m-ildefons
i was looking into the documentation about CI/CD integration and found a few thing that a) could help with overview and b) are outdated information.
Improving the documentation:
- This documentation is very nice, but also very long, this markdown file could really benefit from a table-of-contents section in the header just like the main README.md has: https://github.com/hadolint/hadolint/blob/master/README.md?plain=1#L19-L39
- Sorting the CI/CD Systems or topics by alphabetical order, makes searching easier for the user.
Outdated information:
- According to the GitLab CI section there is a link for "gitlab compatible codeclimate report" this problematic in 2 ways:
- This link is broken and the content seems to be moved from the project/merge_request section to the testing/code_quality* section - Old broken link https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html#implementing-a-custom-tool
- In the internet archive i found this https://web.archive.org/web/20220103201224/https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html#implementing-a-custom-tool and this https://web.archive.org/web/20220915083313/https://docs.gitlab.com/ee/ci/testing/code_quality.html#implementing-a-custom-tool
- The new link could be sort of this: https://docs.gitlab.com/ci/testing/code_quality_codeclimate_scanning/ or https://docs.gitlab.com/ci/testing/code_quality/#import-code-quality-results-from-a-cicd-job - Not sure here, would be helpful to get some feedback.
- Also this feature is now since GitLab 17.3 Depracted and planned to be removed next year in May where GitLab 19.0 will be released. So either a) update the link with a info or b) remove it?
- This link is broken and the content seems to be moved from the project/merge_request section to the testing/code_quality* section - Old broken link https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html#implementing-a-custom-tool
For the docs update i already created an PR see #1118
Reactions are currently unavailable