Commit Graph

257 Commits

Author SHA1 Message Date
Lennart Poettering
b35ec8ded2 docs: uppercase all markdown document titles
For most we used uppercasing, but not for all. Let's stick to one rule,
and uppercase them all.
2020-01-14 10:14:11 +01:00
Lennart Poettering
a0fadf66da docs: drop "The" in categorization titles of Markdown documentation
I think it makes sense to keep the "The" in place for the actual page's
title, but let's drop it from the categorization header, to make it
easier to find stuff, as the "The" isn't helpful to that.

In particular as we sometimes do it this and sometimes the other way so
far, hence let's stick to one common rule.
2020-01-14 10:11:19 +01:00
Zbigniew Jędrzejewski-Szmek
744c49e1fe docs: update link and more dots
Apparently unicode ellipsis is too much for github.
2020-01-13 21:03:15 +01:00
Zbigniew Jędrzejewski-Szmek
0a5a8f13b4 docs: say that journalctl --flush/--sync also require journald
https://github.com/systemd/systemd/pull/14549#pullrequestreview-341758182
2020-01-13 21:01:01 +01:00
Zbigniew Jędrzejewski-Szmek
89f3ba7995 Merge pull request #14557 from poettering/root-storage-daemons-markdown
docs: convert root storage daemon doc to markdown
2020-01-13 20:57:37 +01:00
Lennart Poettering
180f7c26aa docs: import initrd interface documentation from fdo wiki
Imported from https://www.freedesktop.org/wiki/Software/systemd/InitrdInterface/
2020-01-13 20:55:57 +01:00
Lennart Poettering
f8349d2fa5 docs: various small fixes to PORTABILITY_AND_STABILITY markdown
Nothing particularly world moving.

Follow-up for #14549
2020-01-13 20:12:12 +01:00
Lennart Poettering
6e47cac0aa docs: convert root storage daemon doc to markdown
Import from:

https://www.freedesktop.org/wiki/Software/systemd/RootStorageDaemons/
2020-01-13 18:52:56 +01:00
Zbigniew Jędrzejewski-Szmek
d89cde0994 docs: say that various cli progs are independent of pid1 2020-01-12 19:12:15 +01:00
Zbigniew Jędrzejewski-Szmek
ef0bea8cf4 docs: say that dbus api is stable (but list various caveats)
I removed the part about sysv compat, because that has already been removed and
we don't make any use of conditional dbus interfaces afaict.
2020-01-12 18:54:17 +01:00
Zbigniew Jędrzejewski-Szmek
b2eea3dc32 docs: say that all documented programs in $PATH are stable 2020-01-12 18:54:17 +01:00
Zbigniew Jędrzejewski-Szmek
e4893c6306 docs: import "interface stability promise"
In the wiki, this was a separate page. I don't think this split is useful,
since the information about what is stable and what not seems randomly split
between the two pages.

Links are adjusted for our own pages. Some external links to gentoo and other
projects seem to be broken, but it's a chore to fix them.
2020-01-12 18:54:17 +01:00
Zbigniew Jędrzejewski-Szmek
b8b7309778 docs/stability: relax the stance on accepting patches a bit
Instead of saying that patches for portability are not accepted, say that this
is decided case-by-case. This is what happens in practice, and we tend to
discuss each patch on its own merits.

Some sentences are reworded a bit where they sound awkward.
2020-01-11 19:20:35 +01:00
Zbigniew Jędrzejewski-Szmek
02c789f9f9 docs: import stability chart from wiki 2020-01-11 18:47:26 +01:00
Zbigniew Jędrzejewski-Szmek
d2e825b4ab doc: tweak grammar in CONTAINER_INTERFACE description
The only non-stylistic change is to replace descriptions of how we are
encouraging people to use PrivateTmp= and such, because now they are widely
used.
2020-01-08 10:29:10 +01:00
Lennart Poettering
635dea2783 docs: move container interface docs from wiki to markdown
Let's move
https://www.freedesktop.org/wiki/Software/systemd/ContainerInterface/
into our tree and convert it to Markdown.

This also incldues some minor fixes and other changes.
2020-01-06 18:12:22 +01:00
Lennart Poettering
da7667518b docs: CSS files should not be executable 2019-12-16 09:50:02 +01:00
Lennart Poettering
ff2c2d0850 docs: make sure there's only one # markdown header in each file
@bertob wants us to be strict here, and only have one "#" header per
markdown file, and use "##" (or "###", …) for all others. Interestingly,
we mostly got this right already, but this fixes a few cases where this
wasn't correct.
2019-12-13 11:56:08 +01:00
Yu Watanabe
da1b880a3a Merge pull request #14308 from poettering/man-naming-scheme-typo
superficial fixes to network naming docs
2019-12-12 17:04:06 +09:00
Tobias Bernard
b41a3f66c9 docs: make it pretty
Add custom Jekyll theme, logo, webfont and .gitignore

FIXME: the markdown files have some H1 headers which need to be replaced
with H2
2019-12-11 17:04:20 +01:00
Lennart Poettering
7c4a7c6d13 docs: fix markdown links 2019-12-11 12:08:59 +01:00
Lennart Poettering
471d407eaa docs: use `` quotes for marking identifiers of some form 2019-12-11 12:08:55 +01:00
Lennart Poettering
5d3f5e4081 docs: beef up entrypoint documentation page
Let's use the rough categorization of the markdown pages to add basic
sections, via Jeykll templating. Also, add in a couple of additional
links via a JSON array that lists them.

So much web development, so much wow!
2019-12-11 10:53:14 +01:00
Lennart Poettering
4cdca0af11 docs: place all our markdown docs in rough categories 2019-12-11 10:53:00 +01:00
Zbigniew Jędrzejewski-Szmek
b096d14c41 doc: update list of transient units
Doing this manually seem to work only so well, but it is indeed hard to generate
automatically. Let's add the stuff that is missing for now.

AddRef= is not a unit file setting, remove it from the list.
2019-11-27 13:56:29 +01:00