NixOS / nix

Nix, the purely functional package manager
https://nixos.org/
GNU Lesser General Public License v2.1
12.11k stars 1.47k forks source link

missing nodes from docbook -> markdown conversion? #4287

Open abathur opened 3 years ago

abathur commented 3 years ago

I'm picking at some text in the install section and noticed some bullet points that don't make much sense in context.

In this specific case I suspect the itemizedlist's title wasn't supported and was lost in translation. But I bring it up mostly to document the general case, since there may be other places where the text makes less sense post-conversion.

Docbook:

<section xml:id="sect-multi-user-installation">
  <title>Multi User Installation</title>
  <para>
    The multi-user Nix installation creates system users, and a system
    service for the Nix daemon.
  </para>

  <itemizedlist>
    <title>Supported Systems</title>

    <listitem>
      <para>Linux running systemd, with SELinux disabled</para>
    </listitem>
    <listitem><para>macOS</para></listitem>
  </itemizedlist>

  <para>
    You can instruct the installer to perform a multi-user
    installation on your system:
  </para>

Manual:

Screen Shot 2020-11-27 at 3 24 08 PM

Markdown:

# Multi User Installation

The multi-user Nix installation creates system users, and a system
service for the Nix daemon.

  - Linux running systemd, with SELinux disabled

  - macOS

You can instruct the installer to perform a multi-user installation on
your system:
zimbatm commented 3 years ago

At a glance, I am not seeing the issue. What would the proper output look like?

abathur commented 3 years ago

The markdown is missing the text of the itemized list title, so it just has two list items injected with no context. It should probably look more like (I've made this specific edit in the PR I'm working on):

# Multi User Installation

The multi-user Nix installation creates system users, and a system
service for the Nix daemon.

**Supported Systems**
- Linux running systemd, with SELinux disabled
- macOS

You can instruct the installer to perform a multi-user installation on
your system:
stale[bot] commented 3 years ago

I marked this as stale due to inactivity. → More info