Re: Fedora Packaging Guidelines on docs.fedoraproject.org

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Zbigniew Jędrzejewski-Szmek wrote:
> On Fri, Sep 28, 2018 at 02:02:37PM +0200, Igor Gnatenko wrote:
> > We have moved packaging guidelines onto docs.fedoraproject.org[0].
> > If you find any error or would like to change something, don't hesitate to
> > open ticket or submit pull request for packaging committee repo[1].  
> 
> Hmmm, comparing https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_automatically_generated_dependencies
> and https://fedoraproject.org/wiki/Packaging:Python#Automatically_generated_dependencies
> doesn't make me happy.

That doesn't look too bad compared to
https://docs.fedoraproject.org/en-US/packaging-guidelines/Ada/.
Raw markup is displayed instead of links, wildcard characters have been
turned into stretches of bold font, while asterisks that were supposed
to become bold font are displayed instead, HTML var tags have been
removed and replaced with nothing at all, and there is inconsistent use
of monospace font, inconsistent quotation marks, and a stray grave accent
as a cherry on top.

That's what happens when one writes documents in a haphazard ad-hoc
markup language tied to a certain tool, and then tries to switch to
another tool that expects another haphazard ad-hoc markup language.

I was going to try to fix up the Ada guidelines. Obviously I need to be
able to generate HTML from the .adoc file, because the only way to write
in a haphazard ad-hoc language is to make haphazard ad-hoc changes,
preview the result, and repeat until it looks good. Following the
instructions in README.md I installed the package "podman" and ran
"make". After downloading six blobs of unknown contents it failed with
these error messages:

ERRO[0232] could not find slirp4netns, the network namespace won't be configured: exec: "slirp4netns": executable file not found in $PATH 
error: getaddrinfo EAI_AGAIN asamalik.fedorapeople.org:443

I couldn't find any package that provides "slirp4netns", so that was a
dead end. Then I tried the command "asciidoc", because README.md says
that the guidelines are supposed to be written in Asciidoc. That
produced even worse HTML than that at docs.fedoraproject.org, with plus
signs everywhere and a partially mangled bullet list. Apparently the
Asciidoc that these documents are written in isn't the Asciidoc that
asciidoc understands.

This was a disappointing experience. I thought the ability to merge
changes with Git would make it easier to submit changes to the
guidelines. Instead it seems to have become harder. In the wiki I could
at least preview my changes.

By the way, the way that Pagure tries to syntax-highlight the .adoc
files is very confusing. I don't know which language Pagure tries to
syntax-highlight – or rather which two languages, because the way it
sprinkles colors over the file in the "blame" view is entirely different
from what it does in the "blob" view – but it needs to be taught that
these files aren't either of those languages.

Björn Persson

Attachment: pgpHbW46xQDC8.pgp
Description: OpenPGP digital signatur

_______________________________________________
devel mailing list -- devel@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to devel-leave@xxxxxxxxxxxxxxxxxxxxxxx
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/devel@xxxxxxxxxxxxxxxxxxxxxxx

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Index of Archives]     [Fedora Announce]     [Fedora Users]     [Fedora Kernel]     [Fedora Testing]     [Fedora Formulas]     [Fedora PHP Devel]     [Kernel Development]     [Fedora Legacy]     [Fedora Maintainers]     [Fedora Desktop]     [PAM]     [Red Hat Development]     [Gimp]     [Yosemite News]

  Powered by Linux