Documentation: fix formatting, typos, outdated info #1824
Conversation
Documentation/packaging.md
Outdated
There was a problem hiding this comment.
Bah, right you are.
|
While I appreciate the one-sentence-per-line standardisation (and I think it's the right thing for now), I would be remiss if I didn't draw attention to the fact that it might imminently change, per coreos/docs#633 |
|
While we're here we should probably also see if @joshix has some time to review. |
Documentation/commands.md
Outdated
There was a problem hiding this comment.
rkt runs applications packaged according to the open-source [App Container Image][aci-images] specification.
3d1df74 to
df995e9
Compare
There was a problem hiding this comment.
Headings in this file need to be ATX: # Heading.
s/Background/## Background/
There was a problem hiding this comment.
This is fixed, but somehow github insists on the diff not being outdated.
There was a problem hiding this comment.
I have been having that problem with several changesets the last week or so.
|
Needs:
then LGTM to land as an improvement iteration. We can worry about unbreaking the lines later as we formalize coreos/docs#633 and continue to iterate on all of rkt/Documentation/. |
One sentence per line. Add some whitespace between caption and the text or between text and bullet listings. Remove some whitespace errors. Fix language tag in some code snippets. Maybe fix some minor typos.
rkt usually will not be a static binary. We tried once and the result has problems with networking. It is probably like this because statically linking glibc into a binary makes the glibc not to use its plugin based name service switch fully, which is responsible, among others, for resolving domain names.
Let's default to Carly Container with [email protected] email. Taken from appc/spec docs.
df995e9 to
94088a4
Compare
Most of them spotted by Josh Wood
94088a4 to
e8a5bea
Compare
|
LGTM |
Documentation: fix formatting, typos, outdated info
First commit is quite large, because of the one-sentence-per-line formatting, but it mostly is not changing any text.
The rest of the commits are fixing various mistakes.