Page MenuHomeLubuntu

Proofread the Lubuntu Manual
Open, HighPublic

Description

With one (great!) writer doing all the awesome work on the Lubuntu Manual, as with all writing of this sort it should get a second set of eyes to make sure it flows well.

Event Timeline

tsimonq2 created this task.Mon, Oct 8, 9:26 AM
tsimonq2 triaged this task as High priority.

How do i help with this task? How many pages is the manual?

wxl added a comment.Wed, Oct 10, 2:01 PM

@isuzufan first off, good to have you here and thanks for the offer of help! The manual is held in a repository (rMANUAL) which is essentially composed of a bunch of text files in a reStructuredText format. Like other lightweight markup languages, it's highly readable except for some directives for building, which you can ignore. Every hour the public facing manual is rebuilt using the current code base. If you're familiar with using git, you can just submit pull requests using the cool little Phabricator tool Arcanist. If you need further explanation, don't hesitate to ask!

Thanks @wxl. The reStructuredText won't be hard for me to come up to speed on. However, I think I will need more guidance on how to access, work with, and then re-submit the text files. I'm a technical writer, but I usually work with other tools — I haven't worked in a developer environment to create documentation.

I looked at the repository and I see how the /source folder has all the Sphinx project files and then subfolders for chapters. I have no experience with Sphinx. What I would need help with is to set up the Sphinx project and understand how to retrieve, edit and resubmit files. I did see a link to a pycon video where a woman named Carol Willing talks about "Practical Sphinx"....I'll take a look. Any other resources you can suggest?

wxl added a comment.Thu, Oct 11, 3:30 PM

First off, @isuzufan there is no need to learn Sphinx. It's just a build tool. All you need to learn is git and Arcanist as I linked above. I'd be happy to walk you through that. Do you do IRC or what's a good way to connect for real time chat if need be?

I would also like to help up with the task. How do I start?

wxl added a comment.Thu, Oct 11, 4:49 PM

We've got it on the TODO list to make a video on how to do just that @The_LoudSpeaker. We'll be in touch!

Okay. I will be waiting!

Hello gents, and possibly ladies. I've been reading through the documentation and have made some changes in github. Is it okay if I do it this way, or am I causing more work for you guys?

wxl added a comment.Thu, Oct 18, 12:13 AM

@Steedalion unfortunately, the GitHub is not the focus of efforts, but you can use the git repo here, and then (after having installed and setup Arcanist) simply arc diff instead of git pushing.

wxl added a comment.Thu, Oct 18, 12:31 AM

@Steedalion to add to what I say above, since this is the canonical way of doing things, it's probably the best route to go, especially given you'll probably want to do more in the future. That said, we can pull your stuff over from GitHub if need be.