[Rpm-maint] [rpm-software-management/rpm] Docs: Some formatting fixes for macros.md (PR #2251)

Thu Nov 3 00:52:40 UTC 2022

@ferdnyc commented on this pull request.

> +…where `<name>` is a legal macro name and `<body>` is the body of the macro.
+Multiline macros can be defined by shell-like line continuation, ie ``\``

^ Another option would be to have GitHub Actions regenerate the website automatically on every push to the `master` branch. (Or, every push that touches the `docs/` subdir, GitHub Actions' job triggers are capable of that level of precision.)

The Action could either export the generated site content as an Artifact (zip file), for manual update of the rpm.org server... or, it could use stored secret credentials to publish directly to the server. Depends on the level of trust and/or immediacy the maintainers are comfortable granting to an automated workflow.

(Arguably, though, any documentation content that's been checked in to the `master` branch is trusted enough that it's implicitly suitable for the live site. If there is an issue, making it live on the site will help expose it quicker so that the bad commit(s) can be reverted or corrected.)

That GitHub Actions workflow file would then serve as (always-correct-and-current) documentation showing **exactly** how the website HTML is generated. `/docs/README` could be as simple as, "Read `/.github/workflows/website.yaml` and run the commands in the `build` step."

-- 
Reply to this email directly or view it on GitHub:
https://github.com/rpm-software-management/rpm/pull/2251#discussion_r1012411353
You are receiving this because you are subscribed to this thread.

Message ID: <rpm-software-management/rpm/pull/2251/review/1166166589 at github.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rpm.org/pipermail/rpm-maint/attachments/20221102/76462c73/attachment.html>