Page MenuHomeLubuntu

Find a solution for LTS users who want a Lubuntu Manual
Open, HighPublic

Description

I've gotten asked several times today why we don't have a Lubuntu Manual for an LTS release. We could...

  1. Write a separate manual for LTS releases and put it under something like lts.manual.lubuntu.me.
  2. Separate the manual into multiple sections, one for 18.10+ and one for the LTS.
  3. Generalize it so it's not so 18.10-heavy.

Thoughts?

Event Timeline

tsimonq2 created this task.Oct 19 2018, 5:12 PM
tsimonq2 triaged this task as High priority.

I am in favor of 1 or 2 and have been from the start to do that you would have to have the cronjob checkout the LXDE branch and build that with make html. Please do this in a different directory for each version of the manual espically if using make clean as otherwise they would clobber each other on the backend server.

3 would be harder to write and harder for new users to read.

wxl added a comment.Oct 19 2018, 5:41 PM

Read The Docs can just provide a toggle between different versions.

I think dividing by sections is good. @wxl's suggestion sounds good; doesn't the Python documentation do likewise? Another option is to color-code (or otherwise demarcate via CSS?) which statements apply only to which version, but given color-blind and monitor issues that may not be a good idea.

I am surprised to see a manual drafted for 18.10 but not the long-term support version: Given its name containing 'long-term support', I would have thought to find a manual for it first.

I think dividing by sections is good.

That was my hunch as well, I think we should go for it. @lynorian, could you go ahead and make the appropriate structural changes here?

@wxl's suggestion sounds good; doesn't the Python documentation do likewise? Another option is to color-code (or otherwise demarcate via CSS?) which statements apply only to which version, but given color-blind and monitor issues that may not be a good idea.

The only thing is figuring out what module or plugin they use to enable this functionality.

I am surprised to see a manual drafted for 18.10 but not the long-term support version: Given its name containing 'long-term support', I would have thought to find a manual for it first.

Yeah, I would agree, but the manual is a more recent development; we've been focusing hard on the 18.10 release.

Thanks for the feedback @InternetUser1.

wxl added a comment.Oct 19 2018, 7:36 PM

I suggested Read The Docs but it looks like Python isn't using that. They have drop downs for versions and languages. They implemented it themselves and I can't find any module for it. I'd be shocked by this but since everyone uses Read The Docs and they implemented it, why bother?

wxl added a comment.Oct 20 2018, 2:20 PM

Heard from mdk on #sphinx-doc on IRC and I guess Python did this with some special build scripts along with so-called "switchers" in JS.