Opened 16 months ago

Last modified 5 months ago

#14023 new task

Split up glasgow_exts.rst

Reported by: bgamari Owned by:
Priority: normal Milestone: 8.8.1
Component: Documentation Version: 8.0.1
Keywords: newcomer Cc:
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: None/Unknown Test Case:
Blocked By: Blocking:
Related Tickets: Differential Rev(s):
Wiki Page:

Description

The docs/users-guide/glasgow_exts.rst is crazy large. This makes it difficult to navigate both while editing and reading. It should probably be split up into multiple files along the top-level headings.

Change History (5)

comment:1 Changed 10 months ago by bgamari

Milestone: 8.4.18.6.1

This ticket won't be resolved in 8.4; remilestoning for 8.6. Do holler if you are affected by this or would otherwise like to work on it.

comment:2 Changed 8 months ago by bgamari

Keywords: newcomers added

comment:3 Changed 5 months ago by bgamari

Keywords: newcomer added; newcomers removed
Milestone: 8.6.18.8.1

comment:4 Changed 5 months ago by AntC

I support splitting up the file: It is nerve-wracking to edit it for fear of mucking up a section you never intended to touch. Previewing it to see your edits takes a long wait for rendering. And it's too easy to mess up the formatting with result that the contents/index turns to custard.

OTOH there are many cross-references amongst different subsections. Is .rst clever enought to stitch togethere the labels?

comment:5 Changed 5 months ago by bgamari

OTOH there are many cross-references amongst different subsections. Is .rst clever enought to stitch togethere the labels?

Indeed it is (assuming the reference is a :ref:).

I support splitting up the file:

I would love to see this done. My only concern is that we may end up breaking users guide URLs again. That being said, glasgow_exts is getting a bit unwieldy so perhaps this is a worthwhile cost to bear.

Note: See TracTickets for help on using tickets.