colin icon indicating copy to clipboard operation
colin copied to clipboard

Published 20 hours ago • verified publisher icon user-cont

help file check

Open TomasTomecek opened this issue 6 years ago • 3 comments

  • [ ] colin should check whether an image, or container has a help file
    • [x] the name can be help.1 or README.md
    • [ ] in the past it also could have been help.md

https://fedoraproject.org/wiki/Container:Guidelines#Help_File

TomasTomecek avatar Apr 16 '18 10:04 TomasTomecek

It's already there..;-)

We found (with @phracek ), that:

  • redhat speaks only about help.1
  • fedora about help.1 or README.md.

For now, the checks cover:

  • redhat help.1
  • fedora help.1 or README.md

What about help.md? Is it another option or some deprecation?

lachmanfrantisek avatar Apr 16 '18 10:04 lachmanfrantisek

cool, no work!

I actually think that it was renamed from help.md to README.md; let me check.

TomasTomecek avatar Apr 16 '18 10:04 TomasTomecek

I agree with you that help.md is undefined but people still use it. So maybe do a check and flag it as deprecated?

TomasTomecek avatar Apr 16 '18 11:04 TomasTomecek