Skip to content
This repository has been archived by the owner on Oct 15, 2024. It is now read-only.

Commit

Permalink
doc: a few more fixes
Browse files Browse the repository at this point in the history
fixes #4486
  • Loading branch information
Markus Raab committed Sep 30, 2022
1 parent 358d821 commit ff5fb15
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 7 deletions.
17 changes: 13 additions & 4 deletions doc/contrib/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ This document takes preference to the actual situation, so if you see documentat
not according to this document, please [create an issue](https://issue.libelektra.org)
or directly fix it with your next PR.

> Note: It is always allowed to improve the documentation, in every PR, even if it is unrelated.
> Note: It is always allowed to improve the documentation, in every PR, even if
> the documentation fix is completely unrelated.
## Target Groups

Expand All @@ -18,10 +19,16 @@ We write documentation for three groups:
- Contributor
Is a person who does changes within Elektra's repository.

There are 3 separate folders for these 3 groups:

- [for users](/doc/help)
- [for developers](/doc/dev)
- [for contributors](/doc/contrib)

> Takeaway:
> Every document must have a clear target group (user, developer or contributor).
> Sometimes it is clear from the directory, e.g. [doc/help](/doc/help) is for users,
> sometimes it must be explicitly stated, e.g. tutorials.
> Sometimes it is clear from the directory sometimes it must be explicitly stated,
> e.g. tutorials.
## Orientation

Expand Down Expand Up @@ -59,10 +66,12 @@ Elektra's documentation must fulfill:

In general the documentation does not need to be complete.
In particular, we do not want repetition of implementation details as documentation.
[Prefer to write self-documenting code](/doc/CODING.md).
Nevertheless, there are a few must-haves:

- A README.md must be available for every module.
- A man page (help/kdb-) must be available for every command (including external commands).
- A tutorial must be present for every important concept.

## Templates

Expand All @@ -72,4 +81,4 @@ In general we use [arc42.org](https://arc42.org/) but we use specialized templat
- [libs](/src/libs/template/README.md).
- [bindings](/src/bindings/template/README.md).
- [tools](/src/tools/template/README.md).
- [decisions](doc/decisions/template.md)
- [decisions](/doc/decisions/template.md)
5 changes: 3 additions & 2 deletions doc/man/man7/elektra-glossary.7
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
.\" generated with Ronn-NG/v0.10.1
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1.pre1
.TH "ELEKTRA\-GLOSSARY" "7" "December 2021" ""
.TH "ELEKTRA\-GLOSSARY" "7" "September 2022" ""
.SH "NAME"
\fBelektra\-glossary\fR \- glossary of Elektra
.SH "Introduction"
.IP "\(bu" 4
\fBConfiguration settings\fR: customize applications towards the users' needs\. It fulfills following properties:
.IP "\(bu" 4
Expand Down Expand Up @@ -34,6 +33,8 @@ To \fBelektrify\fR an application: to change the application so that it uses Lib
\fBElektra Initiative\fR: is a community that develops LibElektra, expands SpecElektra, improves Elektra's tooling and helps to elektrify applications\.
.IP "\(bu" 4
\fBOption\fR, more specifically \fBCommand\-line option\fR: is a special argument passed on the command\-line\. \fBShort options\fR are single characters prefixed with '\-'; \fBLong options\fR are arbitrarily long and start with '\-\-'\.
.IP "\(bu" 4
\fBModule\fR: The parts Elektra is composed of, i\.e\. either lib, plugin, backend, tool\.
.IP "" 0
.SH "Technical Concepts"
.TP
Expand Down
2 changes: 1 addition & 1 deletion doc/news/_preparation_next_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The next release is not to be expected in this year.

### Olimex

Elektra is used for [server, desktop and embedded](doc/WHO.md).
Elektra is used for [server, desktop and embedded](/doc/WHO.md).
With this release, we again strengthen our embedded mainstay.
We developed a major application running on Olimex boards,
heavily relying on Elektra and [ansible-libelektra](https://github.com/ElektraInitiative/ansible-libelektra).
Expand Down

0 comments on commit ff5fb15

Please sign in to comment.