Hi Josef
The ideas of partials allows one to "boilerplate a document", You just need to
merge the sections you require and run it through asciidoc. Your second task is to review
the technical names in each boilerplate and choose the one that matches a standard.
It will necessitate creating a standard dictionary of some type.
Even with the few wrinkles (dictionary, common terms, etc.) it is a good idea.
Regards
Leslie
Leslie Satenstein
Montréal Québec, Canada
On Monday, March 25, 2019, 12:46:58 p.m. EDT, Petr Bokoc <pbokoc(a)redhat.com>
wrote:
Hi,
that's a pretty good idea. Not sure about "about <product>", those
aren't being reused at all I think (we *could* do that with a bunch of ifdefs, but for
the love of everything that's holy let's not...), but the legal notice or the
feedback page would definitely benefit from an arrangement like that.
I'll get on it let's say next week unless someone really objects to the idea.
Petr
On 3/23/19 6:01 PM, Josef Hruška wrote:
Hello,
I'd like to propose and discuss with you an idea to create a repository that would
contain, let's say, partials which are likely to be reused in Fedora's docs.
Today, I think of Feedback.adoc or Legal_Notice.adoc, for example. But it could be also
"about_fedora", "about_silverblue", descriptions of Fedora's
flavors,...
The thing is I am not sure how strong such a use case it is. Will 3-4 document
components (partials) which will be reused in up to ten documents just suffice to make a
discrete place (repository? module?) for them? Where is the threshold? Could it be less or
rather more?
I hope I didn't mistake myself and partials can be "xrefed" outside a
module or even a repository.
If the repository existed, it would IMO certainly facilitate also translations, for
example (there could be, I assume, just one its translated sources).
I don't count myself among you, the docs writers. I have been translating Fedora for
few years. I've also been following your mail list since I first noticed proposals to
leave Publican tool chain. And this idea has come to my mind very recently, when I try to
follow in my modest capacity the effort to build the tooling around Antora.
Please feel free to react for or against.
Josef Hruska fas: peartown
_______________________________________________
docs mailing list -- docs(a)lists.fedoraproject.org
To unsubscribe send an email to docs-leave(a)lists.fedoraproject.org
Fedora Code of Conduct:
https://getfedora.org/code-of-conduct.html
List Guidelines:
https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives:
https://lists.fedoraproject.org/archives/list/docs@lists.fedoraproject.org
_______________________________________________
docs mailing list -- docs(a)lists.fedoraproject.org
To unsubscribe send an email to docs-leave(a)lists.fedoraproject.org
Fedora Code of Conduct:
https://getfedora.org/code-of-conduct.html
List Guidelines:
https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives:
https://lists.fedoraproject.org/archives/list/docs@lists.fedoraproject.org