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.

Sign up for GitHub

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

Jump to bottom

help file check #83

Open
1 of 3 tasks
TomasTomecek opened this issue Apr 16, 2018 · 3 comments
Open
1 of 3 tasks

help file check #83

TomasTomecek opened this issue Apr 16, 2018 · 3 comments

Comments

@TomasTomecek
Copy link
Member

TomasTomecek commented Apr 16, 2018 •
edited by lachmanfrantisek
Loading

  • colin should check whether an image, or container has a help file
    • 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
@lachmanfrantisek
Copy link
Member

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?

@TomasTomecek
Copy link
Member Author

cool, no work!

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

@TomasTomecek
Copy link
Member Author

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

@dhodovsk dhodovsk mentioned this issue Sep 4, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@TomasTomecek @lachmanfrantisek