Manjaro Linux Forum

Announcements => Announcements, Package & Security Advisories => Topic started by: Roland on 19. September 2012, 01:24:57

Title: Help us with the wiki
Post by: Roland on 19. September 2012, 01:24:57
It would be great if the Manjaro community would support us by filling our Manjaro wiki!

Roland
Title: Re: Help us with the wiki
Post by: eskaini on 19. September 2012, 08:25:52
Yes, I've created an account, and should hopefully be starting from this evening (GMT). I'll be learning how to write wikis at the same time  ::) Saying that, I do have professional experience writing complex documentation, so that will come in useful.

There are two principles I see underpinning this. The first is that structure is of the utmost importance. So far the general headings I am thinking about are:

1. Introduction
subheadings about Manjaro and the team

2. Getting Started
subheadings about getting Manjaro, installing (assisted), installing (by hand), updating the system, etc.

3. Overview of Manjaro
Pacman, etc,

4. Common Tasks

5. Common Problems

And so on. It'll take more shape after I comb through the forums to find items to transfer across as well. Secondly, I hope to keep it as user-friendly as possible with illustrations (where practical) and the use of plain English. It may be worth other users considering translating into other languages, too.





Title: Re: Help us with the wiki
Post by: YFDogan on 19. September 2012, 09:31:32
If it is neccessarry , I could help translate the wiki documentation. May be not exactly the translation, but I can give the users what it is about and what it is telling us to do.
Title: Re: Help us with the wiki
Post by: aeonflux on 19. September 2012, 10:12:33
Started 2 hours ago. I would like if someone could download all the pics in the Installation tutorial, zip them and send them to me. I hope I can finish the page today!

Taking a break.  There are loads of things left, like formatting, and stuff. I'll try to do that after I'm done.
Title: Re: Help us with the wiki
Post by: eskaini on 19. September 2012, 11:17:24
@ Aeonflux: Looking good - and congratulations on being the very first user to contribute to the wiki! Very nice touch with the instructions on burning an ISO in Windows, too. Now I will also be able to look at how you've put it together to figure out the formatting for myself, which should save a lot of time.

@ YFDogan: you never know, your efforts may generate a large Turkish user base. I suspect you'd also definately be the KDE guy  ;)

@ All: I've already worked out what I'll be adding myself tonight (assuming I'm not pipped to the post). With permission from other contributors, I'd also like to maintain the structure of the wiki, unless someone else wants to do this, or someone more competent is available. I will - of course - propose structural changes before making any.

At the moment, I am thinking that it may be worthwhile breaking up the installation guide into seperate pages for some items (e.g. a seperate page for getting Manjaro, and for burning to disc / USB flash drive). This will allow greater detail to be provided, and keep the installation guide itself more focused. Links to these pages can - of course - be provided in the guide itself.

Anyway, I've not actually contributed anything yet, so will start writing my own stuff after getting home from work.
Title: Re: Help us with the wiki
Post by: YFDogan on 19. September 2012, 11:26:57
I met Linux with Pardus. It was a KDE based distro and since then KDE has been my faovorite desktop. And now with MHWD and the support to Bumblebee, Manjaro is my shining star. For KDE reason alone I bought this laptop and added extra ram (from 4 to 8 GB). Hope doing the best at all friend. Thanks :)
Title: Re: Help us with the wiki
Post by: aeonflux on 19. September 2012, 20:24:49
Just finished writing the tutorial. I'll probably upload the images tomorrow.

http://wiki.manjaro.org/index.php/Installation_Guide

Any thoughts?
Title: Re: Help us with the wiki
Post by: eskaini on 19. September 2012, 21:04:49
Nice! I did notice however that a lot of your text had borders around it. From my experience of the Arch-wiki, these are normally reserved for examples of commands to put into the terminal.

A revision may also be necessitated as 0.8.1 may have a slightly different installation process. May be worth holding off until it comes out, and then making the necessary amendments. This is why I haven't written an 'assisted preparation' guide yet (unless you want to!). I was thinking of including this on your installation page, or I can create a separate one for it. What are your thoughts on this?

Oh, and if you feel I'm being a bit heavy handed, please just tell me. No offence will be taken  :)
Title: Re: Help us with the wiki
Post by: aeonflux on 19. September 2012, 21:12:54
Yes, regarding the borders. It's my first time using any kind of WIKI software. To be honest, the syntax is retarded. Leaving a space before a sentence borders the whole line. I couldn't find a better way to match it with the page yet, but I'll try again later.

About the assisted preparation. I think it will be a good idea to include it in the same page, right be before the manual one.

I will also try to change page's name to Beginner's guide, if you guys are ok with it. I've tried earlier but it didn't turn out too good.
Title: Re: Help us with the wiki
Post by: eskaini on 19. September 2012, 21:22:17
Yes, regarding the borders. It's my first time using any kind of WIKI software. To be honest, the syntax is retarded. Leaving a space before a sentence borders the whole line. I couldn't find a better way to match it with the page yet, but I'll try again later.

About the assisted preparation. I think it will be a good idea to include it in the same page, right be before the manual one.

I will also try to change page's name to Beginner's guide, if you guys are ok with it. I've tried earlier but it didn't turn out too good.

LOL - yes, I've been "enjoying" the wiki syntax myself  :'( I'm currently working on the main page. Looking at your own work certainly helped me pick things up faster.

To be honest, it may not be necessary to change the name of the page. Manjaro itself is intended to be accessible by beginners, and there's not a whole lot of difference between the assisted and un-assisted installs. Oh, remind me to put something in about virtual machines in the install guide.

Anyway, I would like your (and anyone else's) advice on the page structure. The key will be finding a balance between splitting things into different pages, and grouping things together in them. While I don't want stuff buried (and lost) in huge super-pages, I don't want a billion little ones, either.
Title: Re: Help us with the wiki
Post by: eskaini on 19. September 2012, 22:55:23
Allright - didn't get as much done as I would've liked today, but have learned enough to start creating a competent Wiki from tomorrow.
Title: Re: Help us with the wiki
Post by: Roland on 20. September 2012, 15:15:08
You are just perfect! Thx a lot to you all! I really like your work on the wiki. We have a very nice Manjaro Community :)
Title: Re: Help us with the wiki
Post by: cumali on 20. September 2012, 15:55:31
Wiki would be nice to be added :)
(http://i.imgur.com/msx4zl.png) (http://imgur.com/msx4z)
Title: Re: Help us with the wiki
Post by: Roland on 20. September 2012, 22:17:25
Done! Thx to Allesandro ;)
Title: Re: Help us with the wiki
Post by: cumali on 20. September 2012, 22:57:38
I would like to thank the team :)
Title: Re: Help us with the wiki
Post by: aeonflux on 21. September 2012, 13:08:34
Added templates for:
Warnings - Warning
Terminal commands - term
Option names - optname
Keys - Keypress

Note, in order to use other characters than letters or numbers, you will have to do this:
{{term|1=# cd /home/username/downloads/}}
this will output

# cd /home/username/downloads/
Title: Re: Help us with the wiki
Post by: eskaini on 21. September 2012, 13:30:26
Added templates for:
Warnings - Warning
Terminal commands - term
Option names - optname
Keys - Keypress

Note, in order to use other characters than letters or numbers, you will have to do this:
{{term|1=# cd /home/username/downloads/}}
this will output

# cd /home/username/downloads/

Nice! Yes, I found the warning one and have been using it. I also noticed you had a green template as well. I'll use those for my tips. Can you tell me how to create these templates?
Title: Re: Help us with the wiki
Post by: aeonflux on 21. September 2012, 13:47:34
Added the following templates:

Tips - Tip
Notes - Note

Regarding your question, I'll make a small ''tutorial'' in the wiki for that.
Title: Re: Help us with the wiki
Post by: eskaini on 21. September 2012, 13:59:52
Great  :)

If - along the line - you can find a way of just putting up thumbnails rather than full size pics as well, then please let me know. Otherwise, I'll look for this myself later tonight.
Title: Re: Help us with the wiki
Post by: aeonflux on 21. September 2012, 14:18:09
Great  :)

If - along the line - you can find a way of just putting up thumbnails rather than full size pics as well, then please let me know. Otherwise, I'll look for this myself later tonight.

1.Posted the template tutorial. Look at the bottom.
2. I have no idea. Unless we host them on imgur.

Title: Re: Help us with the wiki
Post by: aeonflux on 21. September 2012, 14:36:17
Ok, just finished the installation page.

New layout, posted all the images, did some tweaks.
Title: Re: Help us with the wiki
Post by: Roland on 22. September 2012, 12:03:52
You are just great! I love the wiki :)
Title: Re: Help us with the wiki
Post by: guinux on 22. September 2012, 21:49:02
Nice work man !
Power to the community !  ;D
Title: Re: Help us with the wiki
Post by: aeonflux on 24. September 2012, 09:23:04
@verity

Regarding your post on: http://wiki.manjaro.org/index.php/Troubleshooting

That will only work on Ubuntu and Ubuntu based distros. On Arch is a bit differnet. May I edit your post?
Title: Re: Help us with the wiki
Post by: eskaini on 24. September 2012, 10:40:18
@verity

Regarding your post on: http://wiki.manjaro.org/index.php/Troubleshooting

That will only work on Ubuntu and Ubuntu based distros. On Arch is a bit differnet. May I edit your post?

Do you mean the screen brightness issue? I tested it on Manjaro after I installed it as my main OS and it seemed to work fine. Perhaps it may be worthwhile adding an extra section to this fix as an alternative?

Oh, please take a look at the installation page. I've started adding the non-assisted preparation section. You may also see that I've figured out how to scale down pictures. As our guides are virtually identical, how do you feel about just having a single guide with seperate assisted and non-assisted sections? If you wish to keep the guide as-is, I could scale down the pcitures for you. Or I could leave it alone alogether if you wish  :)

PS - if you have the time, what do you think about moving the guide  from How to --> touchpad page into the main how to page as a seperate section (i.e. underneath the auto login guides)?
Title: Re: Help us with the wiki
Post by: aeonflux on 24. September 2012, 12:55:35
The update-grub command will not work in Archlinux.

I've edited it for you: http://wiki.manjaro.org/index.php/Troubleshooting

You might want to remove what's between the equal signs :). The first part should work on any Linux distro that uses GRUB(2).

Regarding the Installation tutorial, yes it might be a good idea to resize the images. However, there are a few dozens of images. What would be the fastest method for resizing them?

Edit: Figured it out. But aren't they to small at 375 pixels?
Edit2: The wole page formatting messes up.
Title: Re: Help us with the wiki
Post by: eskaini on 24. September 2012, 13:38:49
The update-grub command will not work in Archlinux.

I've edited it for you: http://wiki.manjaro.org/index.php/Troubleshooting

You might want to remove what's between the equal signs :). The first part should work on any Linux distro that uses GRUB(2).

Regarding the Installation tutorial, yes it might be a good idea to resize the images. However, there are a few dozens of images. What would be the fastest method for resizing them?

Edit: Figured it out. But aren't they to small at 375 pixels?
Edit2: The wole page formatting messes up.

Don't worry about the image sizes - they can be clicked to bring up the full size versions. If the formatting is messing up, add <br clear="all" /> after the picture and its accomanying text, e.g:

Code: [Select]
[[file: xxx|thumb|left|375px]]

[your text for the image]

<br clear="all" />

And repeat.

As I am very much a newbie, could you also explain the screen dimming change for me? From my perspective, Manjaro uses GRUB2, and the "sudo update-grub" command did work for it. Am I right in thinking that your update command is intended for Arch, which uses GRUB 1? Will the command work on both GRUB versions? Is the intention for the Manjaro wiki to apply to Arch users as well?
Title: Re: Help us with the wiki
Post by: aeonflux on 24. September 2012, 13:51:14
Don't worry about the image sizes - they can be clicked to bring up the full size versions. If the formatting is messing up, add <br clear="all" /> after the picture and its accomanying text, e.g:

Code: [Select]
[[file: xxx|thumb|left|375px]]

[your text for the image]

<br clear="all" />

And repeat.

As I am very much a newbie, could you also explain the screen dimming change for me? From my perspective, Manjaro uses GRUB2, and the "sudo update-grub" command did work for it. Am I right in thinking that your update command is intended for Arch, which uses GRUB 1? Will the command work on both GRUB versions? Is the intention for the Manjaro wiki to apply to Arch users as well?

It's weird that it works for you. If you say so, I've edited it again.

Anyways, did you really have to make a 2nd wiki account just to change it? Whatever.
Title: Re: Help us with the wiki
Post by: eskaini on 24. September 2012, 13:58:40
It's weird that it works for you. If you say so, I've edited it again.

Anyways, did you really have to make a 2nd wiki account just to change it? Whatever.

I've not created a second wiki account  :o Nor have I done any editing today - I'm at work, and am already pushing it by posting on this forum. Why not check the logged IP addresses to confirm? Like I said, I'm not possessive about my work, so you and any others can change what you wish.

Let's not fall out over a misunderstanding - so far we have worked very well together. I'd like to keep it that way.

PS - you can remove the update grub command if you like. I genuinely wanted to know how the new command worked to better understand the system .
Title: Re: Help us with the wiki
Post by: eskaini on 24. September 2012, 14:55:18
HavenĀ“t you been told that everytime someone fights in here a rabbit kills a banana ?
Title: Re: Help us with the wiki
Post by: guinux on 24. September 2012, 15:38:34
Quote
The update-grub command will not work in Archlinux.
"update-grub" doesn't work in Archlinux but it's implemented in Manjaro, it does the same thing that "gruk-mkconfig -o /boot/grub/grub.cfg", it's just easier to remember.
Knowing this, I modified http://wiki.manjaro.org/index.php/Troubleshooting
Title: Re: Help us with the wiki
Post by: aeonflux on 24. September 2012, 16:34:32
My bad. Sorry for accusing you. But I saw that someone made an account just to edit what I wrote; I was thinking, why would a random person go straight to that post? Anyways, sorry, again. Everything is ok now, back like it was.

I didn't know that the grub-update command works in Manjaro, since it's Arch based, I never thought the devs modified it like that. Anyways, I hope we are cool, and sorry again for what happened.
Title: Re: Help us with the wiki
Post by: eskaini on 24. September 2012, 19:02:40
My bad. Sorry for accusing you. But I saw that someone made an account just to edit what I wrote; I was thinking, why would a random person go straight to that post? Anyways, sorry, again. Everything is ok now, back like it was.

I didn't know that the grub-update command works in Manjaro, since it's Arch based, I never thought the devs modified it like that. Anyways, I hope we are cool, and sorry again for what happened.

No problem - already forgotten about!
Title: Re: Help us with the wiki
Post by: eskaini on 25. September 2012, 22:38:36
Update: Finished the Beginner's installation guide. Thanks to the hard work of aeonflux and yfdogan, the experienced user's installation guide has been completed as well.

If anyone has the time, please scan them over, and report any errors, inaccuracies, etc, here.
Title: Re: Help us with the wiki
Post by: Roland on 26. September 2012, 06:53:05
I am again impressed. I have just seen it and I need to thank you again! Nice screenshots by the way :)