Change checksum number - Githubissues

theforeman / foreman-documentation

Documentation for the Foreman Project and its ecosystem

https://docs.theforeman.org

Creative Commons Attribution Share Alike 4.0 International

22 stars 95 forks source link

Change checksum number #3261

Closed bangelic closed 2 months ago

bangelic commented 2 months ago

The checksum number sha1 is no longer secure and modern systems support file checksums greater than sha1. It has been replaced with the correct checksum values.

[x] I am okay with my commits getting squashed when you merge this PR.
[x] I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

[x] Foreman 3.12/Katello 4.14 (Satellite 6.16)
[ ] Foreman 3.11/Katello 4.13
[ ] Foreman 3.10/Katello 4.12
[ ] Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
[ ] Foreman 3.8/Katello 4.10
[ ] Foreman 3.7/Katello 4.9 (Satellite 6.14)
[ ] Foreman 3.6/Katello 4.8
[ ] Foreman 3.5/Katello 4.7 (Satellite 6.13; orcharhino 6.6/6.7)
We do not accept PRs for Foreman older than 3.5.

github-actions[bot] commented 2 months ago

The PR preview for bdf3121496e161cd47ecbf3338631c71d99286f9 is available at theforeman-foreman-documentation-preview-pr-3261.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

asteflova commented 2 months ago

Merged to "master" and cherry-picked:

8818dd1d2a..ba81cc5170 3.12 -> 3.12

asteflova commented 2 months ago

For the record, this is why I'm not a fan of copy-pasting information from man pages or --help pages :) We just end up maintaining the same information in two places without offering additional value.

(@bangelic This is not a commentary on your effort! It's great that you keep the docs up-to-date, this is not something that you could have influenced. Thank you for the PR.)

ekohl commented 2 months ago

For the record, this is why I'm not a fan of copy-pasting information from man pages or --help pages :) We just end up maintaining the same information in two places without offering additional value.

If you duplicate it (and I emphasize the if), IMHO you need to have an automated way to update it. For example, https://github.com/theforeman/theforeman.org/tree/gh-pages/scripts/installer has scripts to automatically retrieve the correct info and provide it in the same format. It could certainly be better by working even more with 100% generated files that are included, but it's reasonably easy to maintain.

Manually keeping things in sync is a recipe for problems.

asteflova commented 2 months ago

We publish this information in an automated way through a script in the Hammer CLI guide. It has a section on hammer repository create (Satellite 6.15 so it still lists sha1). Furthermore, now that I compare the section on hammer repository create in Managing Content and Hammer CLI Guide, it seems that the list of options in Managing Content is far from complete, presumably because no one has been adding new options.