Allow editing "Drupal User Guide" and pages under it

Created on 12 October 2023, about 1 year ago

Problem/Motivation

The Drupal User Guide β†’ cannot be edited.

Sub-pages such as 2.2. Planning Your Site Layout β†’ cannot be edited, nor followed.

Proposed resolution

Allow editing Drupal User Guide β†’ and sub-guides/pages.

Remaining tasks

πŸ“Œ Task
Status

Closed: works as designed

Version

10.0

Component

User Guide content

Created by

πŸ‡©πŸ‡°Denmark ressa Copenhagen

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @ressa
  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

    Moving this to the Drupal User Guide queue because those pages are managed by a different project.

    The content of these pages is generated from the asciidoc source files in the repo associated with this project. You can edit the content of a page by patching the corresponding asciidoc file. This choice was made for a bunch of reasons including:

    • Better editorial control via Git
    • Requires that changes are reviewed by someone instead of being published without review
    • System allows for translation, and tooling related to maintaining translated versions
    • Ebooks are generated and published (though honestly I'm not sure how much these ever get used)
    • And more ...

    There's more background in this post https://groups.drupal.org/node/470648.

    Personally I'm not opposed to changing things around, but I do think we should make sure we're addressing the same concerns and either deciding we're not worried about it anymore, or that we have a different way of dealing with them now.

    Also, I'm happy to add other people as maintainers to the guide project if you're interested in helping with keeping the updated. :)

  • Status changed to Closed: works as designed about 1 year ago
  • πŸ‡©πŸ‡°Denmark ressa Copenhagen

    Thanks for a fast answer @eojthebrave. I should have read the Official Docs β†’ page closer, but just skipped straight to skimming the Warning box and focused on "... publishing them via the repo was cumbersome and slowed down updates. And the pages were never translated.".

    But I do agree with the arguments for keeping the Drupal User Guide in the current format, and not let everyone edit the pages, for a tighter control over the formatting standards, as well as the other reasons you list.

    A lot of work has gone into making it publishable as an e-book, which I think is very admirable, and which I am very grateful for. And good to hear that the project is open for additional maintainers :)

Production build 0.71.5 2024