Documentation: fix formatting, typos, outdated info #1824
Conversation
| The generated archive `stage1.aci` will not contain bash, systemd that comes from external sources. | ||
| The only binaries in the archive are built from the sources in the rkt git repository. | ||
| Since stage1.aci needs external binaries, they will be taken from the host at run-time. | ||
| Packages using the `--with-stage1-flavor=host` option must therefore add a run-time dependency on systemd and bash. |
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. |
|
|
||
| ## Downloading Images (ACIs) | ||
|
|
||
| [aci-images]: https://github.com/appc/spec/blob/master/spec/aci.md#app-container-image | ||
| [appc-discovery]: https://github.com/appc/spec/blob/master/spec/discovery.md#app-container-image-discovery | ||
|
|
||
| rkt runs applications packaged as [Application Container Images (ACI)][aci-images] an open-source specification. ACIs consist of the root filesystem of the application container, a manifest and an optional signature. | ||
| rkt runs applications packaged as [Application Container Images (ACI)][aci-images] an open-source specification. |
There was a problem hiding this comment.
rkt runs applications packaged according to the open-source [App Container Image][aci-images] specification.
krnowak
force-pushed
the
krnowak/docs-fixes
branch
from
3d1df74
to
df995e9
Compare
| @@ -4,45 +4,35 @@ User namespaces | |||
| Background | |||
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 carly@example.com email. Taken from appc/spec docs.
krnowak
force-pushed
the
krnowak/docs-fixes
branch
from
df995e9
to
94088a4
Compare
Most of them spotted by Josh Wood
krnowak
force-pushed
the
krnowak/docs-fixes
branch
from
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.