Changes
Page history
move template issue to the known issues
authored
Feb 08, 2021
by
anarcat
Show whitespace changes
Inline
Side-by-side
service/documentation.md
View page @
afb070f1
...
@@ -317,6 +317,25 @@ people review changes done to it. As [Jacob Kaplan-Moss quipped](https://jacobia
...
@@ -317,6 +317,25 @@ people review changes done to it. As [Jacob Kaplan-Moss quipped](https://jacobia
In other words, we'd need a technical writer to review our docs, or at
In other words, we'd need a technical writer to review our docs, or at
least setup a self-editing process the way Kaplan-Moss suggests above.
least setup a self-editing process the way Kaplan-Moss suggests above.
### Templating
The current "service template" has one major flaw: when it is updated,
the editor needs to manually go through
*all*
services and update
those. It's hard to keep track of which service has the right headings
(and is up to date with the template).
One thing that would be nice would be to have a way to keep the
service pages in sync with the template. I
[
asked for suggestions in
the Hugo forum
](
https://discourse.gohugo.io/t/using-and-maintaining-markdown-templates/31020
)
, where a simple suggestion was to version the
template and add that to the instances, so that we can quickly see
when a dependency needs to be updated.
To do a more complete comparison between templates and instances, I
suspect I will have to roll my own, maybe something like
[
mdsaw
](
https://gitlab.com/hydrargyrum/mdsaw
)
but using a real parse tree.
See also
[
scaraplate
](
https://scaraplate.readthedocs.io/
)
and
[
cookiecutter
](
https://cookiecutter.readthedocs.io/
)
.
## Goals
## Goals
Note: considering we
*just*
migrated from ikiwiki to GitLab wikis, it
Note: considering we
*just*
migrated from ikiwiki to GitLab wikis, it
...
@@ -417,11 +436,5 @@ GitLab wikis.
...
@@ -417,11 +436,5 @@ GitLab wikis.
See also
[
this LWN article
](
https://lwn.net/Articles/822969/
)
.
See also
[
this LWN article
](
https://lwn.net/Articles/822969/
)
.
One thing that would be nice would be to have a way to keep the
service pages in sync with the template. I
[
asked for suggestions in
the Hugo forum
](
https://discourse.gohugo.io/t/using-and-maintaining-markdown-templates/31020
)
but I suspect I will have to roll my own, maybe
something like
[
mdsaw
](
https://gitlab.com/hydrargyrum/mdsaw
)
but using a real parse tree. See also
[
scaraplate
](
https://scaraplate.readthedocs.io/
)
and
[
cookiecutter
](
https://cookiecutter.readthedocs.io/
)
.
[
vale
]:
https://errata-ai.gitbook.io/vale/
[
vale
]:
https://errata-ai.gitbook.io/vale/
[
markdownlint
]:
https://github.com/DavidAnson/markdownlint
[
markdownlint
]:
https://github.com/DavidAnson/markdownlint