User manual project

Jaerrib · 2018-11-21 17:01

Hello,

I'm new to the forum, but I've been using Q4OS for some time after distro hopping like many others. As I've come to appreciate all the goodness of this operating system, I decided I wanted to give back to community in some way. First on my list is compiling the already excellent documentation found on the Q4OS web site into a user manual similar to what Linux Mint and Manjaro have done and making it available in pdf format for easy downloading. This will be done via a Github repo (which I will be setting up shortly) to allow collaboration. My plan is to create the master document in odt format which can then be exported as a pdf. The manual, based on the existing documentation, will likely be sparse initially, but I would to like to expand it with screenshots, tips, and tutorials from the community over time. I will post more in this space when I have more information to share. In the meantime, thanks to the Q4OS team for their hard work!

q4osteam · 2018-11-21 17:13

Any contribution is appreciated, thank you and welcome to the forum

Jaerrib · 2018-11-30 02:47

I've created a repo on Github for the Q4OS User Manual and uploaded a 0.1 version in odt format. At this stage, it's essentially a compilation of the existing Q4OS documentation with an added table of contents and minimal editing. I will continue editing the text for grammar, etc. first then start adding screen shots where they are applicable. I would also like to have some sort of cover art like the Manjaro guide but that can come later.Anyone wishing to contribute, please let me know!

https://github.com/jaerrib/q4os-user-manual

q4osteam · 2018-11-30 08:25

Great job, thanks. There are a few obsolete parts, for example regarding to KDE4 desktop, in our documentation, we will edit and fix them as soon as possible.

q4osteam · 2018-12-02 13:46

We have edited obsolete parts and updated the documentation https://www.q4os.org/dqa007.html

Jaerrib · 2018-12-03 01:00

Thanks! I've been working on minor grammar edits here and there. What sections aside from alternative desktops were changed? I'll get those updated as well.

q4osteam wrote:

We have edited obsolete parts and updated the documentation https://www.q4os.org/dqa007.html

q4osteam · 2018-12-03 08:06

No other significant changes, except a small corrections has been made so far. We will go through your compilation and port grammar fixes back to the original. Great job, thanks

Jaerrib · 2018-12-09 04:18

Various changes on Github including:
- Replaced image on title page with revised Q4OS logo.
- Updated several links to point to sections within document instead of web URLs.
- Added an initial pdf version.

I attached the pdf to this post for those that just want to check things out without going to Github.

Attachments:

q4os-user-guide.pdf, Size: 218.86 KiB, Downloads: 9,931

UAOS · 2018-12-15 14:05

Jaerrib · 2019-01-06 03:22

I added some installation and customization tutorials on a branched version of the user guide. These are courtesy of Dai Trying. (Thank you!!) I still need to do some formatting and restructuring to eliminate duplicate information between the original Q4OS documentation and Dai's work. I will also probably move the Live CD/USB creation to another section so that the installation section doesn't get too overwhelmed with information before even getting to the part about how to install the OS. All of this will eventually be moved into the master branch. In the meantime, you can check out the current 0.3.1 version here: https://github.com/jaerrib/q4os-user-ma … -tutorials

Dai_trying · 2019-01-06 10:41

Nice work! This project is looking good and progressing nicely, I do think this will be very useful to keep on a thumbdrive for times when you need to check back on something during installation, I shall also keep a copy on my tablet to make it always available. Thank you and well done

q4osteam · 2019-01-06 12:33

Thanks, we have added two more bits into the documentation, you could add it to the project as well:
https://www.q4os.org/dqa007.html#tips.6
https://www.q4os.org/dqa011.html#system.3

EDIT1: We have also replaced all "apt-get" commands with "apt" in all documentation.

EDIT2: We could also suggest you to add a part for developers "How to remaster Q4OS Live CD" based on the forum thread here:
https://www.q4os.org/forum/viewtopic.php?id=1214

q4osteam · 2019-01-06 15:53

We have created an initial testing version of installer for Q4OS users to be able to easily install and view the manual in Q4OS, see the link below. Could we add installer's source files into the project repository ?

Installer download:
https://sourceforge.net/projects/q4os/f … a1_all.esh
Download and launch it from file manager just by double-click.

Last edited by q4osteam (2019-01-06 16:09)

Jaerrib · 2019-01-06 21:41

Added the two new documentation bits on screen resolution. Replaced all "apt-get" references with just "apt", and added a remastered Q4OS section. Made some more minor edits and merged everything with master. Presently at version 0.3.2!

Jaerrib · 2019-01-06 21:44

q4osteam wrote:

We have created an initial testing version of installer for Q4OS users to be able to easily install and view the manual in Q4OS, see the link below. Could we add installer's source files into the project repository ?

I think this a great idea! You can absolutely add the installer's source files to the repo.

Installer download:
https://sourceforge.net/projects/q4os/f … a1_all.esh
Download and launch it from file manager just by double-click.

On a side note, this crashes for me for me when I try to run it.

q4osteam · 2019-01-06 23:48

Well, we need permissions to push installer into the repository, please make it accessible.
Github name: q4osteam

Jaerrib · 2019-01-07 00:38

q4osteam wrote:

Well, we need permissions to push installer into the repository, please make it accessible.
Github name: q4osteam

Okay, I think I added you correctly. I'm not used to managing other users/permissions on Github at all.

q4osteam · 2019-01-07 08:27

Installer added in testing version so far, you are welcome to improve it, for ex. add custom text, images, etc. You can find a useful info in the "/opt/program_files/q4os-devpack/appsetup/q4os_setup.cfg.sample" file.

Jaerrib · 2019-01-08 02:50

q4osteam wrote:

Installer added in testing version so far, you are welcome to improve it, for ex. add custom text, images, etc. You can find a useful info in the "/opt/program_files/q4os-devpack/appsetup/q4os_setup.cfg.sample" file.

Thanks. The installer still doesn't work for me for some reason. I'll have to poke around a bit. I've been meaning to do that anyway but haven't had a specific reason to do so previously.

q4osteam · 2019-01-08 08:26

We have created a new "0.2" release https://github.com/jaerrib/q4os-user-ma … s/tag/v0.2 , we have compiled a new version of installer too, is it still crashing ? It works fine here though.

We could also make all our html documentation a part of this project, what do you think about that ?

Jaerrib · 2019-01-09 03:27

q4osteam wrote:

We have created a new "0.2" release https://github.com/jaerrib/q4os-user-ma … s/tag/v0.2 , we have compiled a new version of installer too, is it still crashing ? It works fine here though.

Still crashing. I'm sure it's something on my end though. I attached the crash log that was generated if that helps.

We could also make all our html documentation a part of this project, what do you think about that ?

I'm okay with copying and pasting from the website. However, adding the html documentation is a nice way to have the original source available alongside the other files. Sounds like a good idea to me!

Attachments:

installer_crash_log.txt, Size: 12.51 KiB, Downloads: 799

q4osteam · 2019-01-09 09:58

We have added the html source documentation, anyone is welcome to make a grammar corrections as well as some more significant improvements. We will synchronize it with the official site afterwards.

We have also created a separate topic regarding to the installer crashing https://www.q4os.org/forum/viewtopic.php?id=2481 , we would need to check it in depth, as it could lead to a quite important fix.

q4osteam · 2019-01-11 09:09

@Jaerrib
A fix to the installer has been released, you could attempt to install the user manual once again and post back a result, if possible.

First you need to update your system to get the fixed installer version:
$ sudo apt update
$ sudo apt dist-upgrade

Dai_trying · 2019-01-11 15:08

I have updated and ran the installer via konqueror a couple of times and it seems to have fixed it for me.

Jaerrib · 2019-01-12 01:01

q4osteam wrote:

@Jaerrib
A fix to the installer has been released, you could attempt to install the user manual once again and post back a result, if possible.
First you need to update your system to get the fixed installer version:
$ sudo apt update
$ sudo apt dist-upgrade

That fixed the crashing issue I had with the installer. Everything seems to have installed correctly. Thanks for your work on this!

Two questions for you though:
1. How does one go about adding an icon to the installer so that the desktop shortcut isn't a question mark in a rectangle?
2. Is there a way for the icon to look different depending on the icon theme in use?

Q4OS Forum

#1 2018-11-21 17:01

User manual project

#2 2018-11-21 17:13

Re: User manual project

#3 2018-11-30 02:47

Re: User manual project

#4 2018-11-30 08:25

Re: User manual project

#5 2018-12-02 13:46

Re: User manual project

#6 2018-12-03 01:00

Re: User manual project

#7 2018-12-03 08:06

Re: User manual project

#8 2018-12-09 04:18

Re: User manual project

#9 2018-12-15 14:05

Re: User manual project

#10 2019-01-06 03:22

Re: User manual project

#11 2019-01-06 10:41

Re: User manual project

#12 2019-01-06 12:33

Re: User manual project

#13 2019-01-06 15:53

Re: User manual project

#14 2019-01-06 21:41

Re: User manual project

#15 2019-01-06 21:44

Re: User manual project

#16 2019-01-06 23:48

Re: User manual project

#17 2019-01-07 00:38

Re: User manual project

#18 2019-01-07 08:27

Re: User manual project

#19 2019-01-08 02:50

Re: User manual project

#20 2019-01-08 08:26

Re: User manual project

#21 2019-01-09 03:27

Re: User manual project

#22 2019-01-09 09:58

Re: User manual project

#23 2019-01-11 09:09

Re: User manual project

#24 2019-01-11 15:08

Re: User manual project

#25 2019-01-12 01:01

Re: User manual project

Board footer