-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Slim down README.md and make tutorials page #230
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
Slim down README.md and make tutorials page #230
Conversation
|
@TomSweeneyRedHat You have whitespace errors. |
|
@rhatdan thx, think I just nixed them. Empty line at the end of two files. |
README.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would like to see this section cleaned up if possible. As of now, it looks like an orphaned list of links.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Think I've done so, open to further suggestions. Will repost shortly.
README.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we have a small description of the tutorial around this? And perhaps in line with the above comment, somehow reformat/reorganize to make it pop a little more
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ditto previous comment.
Signed-off-by: TomSweeneyRedHat <[email protected]>
|
Going to close/reopen to rekick the tests. |
|
📌 Commit 0aa2459 has been approved by |
|
⌛ Testing commit 0aa2459 with merge 3b6d208... |
|
💔 Test failed - status-papr |
|
@rhatdan can this be merged? Red Hat CI is still failing, but absolutely no logs/errors to show what's up. |
|
Merging since this is a docs change only and cento and travis are fine. Not sure what is broken in the infrastructure. |
Signed-off-by: TomSweeneyRedHat [email protected]
This moves the tutorials down underneath their own page and directory in the docs directory to emulate what we did with Buildah. In addition I slimmed down README.md to make it a quick read for someone wanting to know about the project. The commands took up a lot of space so I've moved them to their own page. We did similar changes with Buildah. The gist is to provide them with high level information on the README,md with the real meat to be found with links from it.
More tutorials are in the works, thus I left the verbiage as plural there. I plan to create another example based on the examples in the podman run man page.