See the previous commit message. The Javascript Guidelines had the same
problem, but it required more textual changes to make the document
internally consistent while still expressing (what I think is) the
intended meaning.
See #1496.
The current text of the Guidelines are confusing because in once
paragraph it says CSS must be re-generated and in another it says it
doesn't have to be. This clarifies the text so it is inline with
decision made in https://pagure.io/fesco/issue/3269.
There is no strong reason to universally recommend %global over %define,
and RPM upstream has good documentation in rpm-macros(7) explaining the
difference.
See #1449 and
#1454 for
more discussion.
Closes: #1449
The Antora server will include a language-switching link
and an edit link for each file, both of which aren't
valid in the preview and need to be ignored.
The edit link takes the form `file:///antora/...`,
a path that's only valid inside the container.
The language link points from every document
`https://localhost:8080/guidelines/foo`
to a language-specific URL like
`https://localhost:8080/en-US/guidelines/foo`
The latter may need to be tweaked if they're dependent on
the system locale of the user running linkchecker.
Ignoring `https://localhost:8080/en-US` works for me,
but may not be universal.
Instead of using podman commands directly in the Makefile, add
the `docsbuilder.sh` script from the [docs templates repo][1].
Rewrite the Makefile to use docsbuilder commands to perform
its functions.
Changes:
- The preview URL changes from `https://localhost:8000` to
`https://localhost:8080/`
- `build` is now a synonym for `doc`
- `serve` now runs `docsbuilder -p` which automatically
rebuilds the doc first
- `watch` is now available to start a server that
automatically rebuilds the preview on file changes
- `linkcheck` will automatically start a preview server
before running `linkchecker`
[1]: https://gitlab.com/fedora/docs/templates/fedora-docs-template
FESCo approved this in https://pagure.io/fesco/issue/3473:
> AGREED: /nix top-level directory may be used exclusively for Nix
> runtime and package store. It shall not be part of the filesystem
> package, but packages are allowed to create it. (+6, 1, -0)
- Just say that systemd unit files must be shipped in either
%{_unitdir} or %{_userunitdir}, with them being the appropriate
place for system services and user session services, respectively.
- Drop what the macros expand to - information like that tends to get
outdated (though admittedly, that is unlikely in this case).
- Also drop "needed early in the boot process". This is just weird and
out of context in this section, and doesn't explain anything unless
you happen know how initramfs are constructed by dracut.
Fixes: https://pagure.io/packaging-committee/issue/1467
With the latest Go Vendor Tools, `%license vendor/modules.txt` no longer
needs to be listed explicitly. The text of the guidelines is correct,
but the code snippet still showed it listed alongside `%files -f
%{go_vendor_license_filelist}`.
