We must organize the doc

Yeah! Looks really good, please add it here
http://wiki.nethserver.org/doku.php?id=howto_s

Of course, I don’t want to move everything inside READMEs. I think a README inside a git repo should be written by a developer for other developers. It should describe DB, dependencies, useful debug commands for the code stored into the git repo. The main advantage is having documentation synchronized with the code over the time. It’s easy to retrieve the right documentation version for an old git tag, or different code branches.

The developer manual should contain project rules and conventions, general APIs that don’t change over time and links to READMEs.

I’ve found the wiki is good for howtos, exposing new ideas and coordinating initiatives (like ns7), and whatever comes to mind.

At the moment IMHO, we don’t need extra work just for technical improvements, we definitely need new docs and new getting started howtos about common case studies! Full of images and examples :smile:
I’d like to focus on this effort asking the help of the whole community!

9 posts were merged into an existing topic: Working on “Howto Set Up a VPN”

I would like to poke the DocTeam @AbsyntH, @sitz, @Ctek, @stephdl, @WillZen, @Jim to fill the wiki ans submit a little idea:

I would like to have in the wiki left menu, one entry “quick start”, or “start here” to have a page to regroup all articles “… for dummies”, with the same presentation as the how to page.

With this, we can link directly all article “…for dummies” or recreate (copy/paste) in the wiki all existing article.

Or did you prefer to split the actual “how to” page and put all article " for dummies" here?

That’s a good idea! Currently getting where to start isn’t straightforward.
@sitz could lend a hand with the Dummies part!

You have the volunteering page, that you can find on the first page and also the help page accessible on the left menu but i did not catch you when you talk about dummies content !!!

The first wiki page lack of orientations.

Let me explain what I mean:
We have the welcome message, it’s ok and good.
We have the presentation of Nethserver, well done.
And we have Volonteering, for someone who already want to go further.

But there.s nothing for someone who want only consult the doc, or knowing a little more about NethServer, what kind of feature or technology, or for someone which need help for installation step, or type of material supported.

There’s the left menu, but this one is for shortcuts, it’s not showing the structure of the documentations, neither a path to discover Nethserver, actually there’s no orientation too in the left menu.

The wiki is young, and we can’t do the perfect shot at first, but we have to structure the fisrt page for all kind of audience, the newcomer, the docummentation digger, the old wolf… and this smarter and smoother

The two exemples I have in mind are:
https://wiki.gentoo.org/wiki/Main_Page
https://wiki.debian.org/

We must do better than this:

1 Like

Where the e-smith for dummies? :joy:

This is a start… http://wiki.nethserver.org/doku.php?id=howto:db_command_tutorial

You have also a sitemap http://wiki.nethserver.org/doku.php?id=start&do=index

Obviously a wiki is alive so each version of ns should have its own page with all pertinent informations

I made few modificationin the landing page.
What do you think about?

1 Like

Can we change the header of the wiki?

Can we change for NethServer WIKI or NethServer Documentation?..
Because NethServer Doc don’t give a good feeling :unamused:

I would like to organize a little more the how to page http://wiki.nethserver.org/doku.php?id=howto_s

I think a second tag could help for this

Which one ?

What do you think about “installation”," dummies",“general” and “testing”

Jim

Imho a tag must categorise a content you need and you are looking for.

So vpn,webapp,apache,mysql, and much more like installation are good tags but i’m not sure concerning tag about levels (novice…middle and experimented.)

From my point of view any howto must reach the goal of the reader…even for a beguiner.

Of course jim it is only my 2c thought and if you need to add more tag…go. You can find all used tags in the help page and there http://wiki.nethserver.org/doku.php?id=category

Very interesting for people who are asking about e-smith and other things under the hood

I made few change in the How To page.
http://wiki.nethserver.org/doku.php?id=howto_s

@AbsyntH, @sitz, @Ctek, @stephdl, @WillZen, @Jim
What do you think ?

Edit:
Who can help to make Howto for dummies?
I think to have
how to setup a DHCP Server,
how to put a rule ( Red, orange, green ) on a interface,
how to configure the proxy

Such stuff can be very helpful for newcomer and for a first approach for someone who just discover NethServer and investigate possibilities.

Edit 2: do you think it can be useful to add the level? ( beginner, intermediate, advanced )

Edit 3: @sitz Can I copy paste your howtos for dummies from Discourse to Docuwiki?

1 Like

I made my first howto for dummies
A real history that occurred here… Someone forget the comma :laughing:

Edit: in the How to setup the DNS and How to setup the DHCP, I pick from the administrator manual.
I must mention it, or not?

2 Likes

@Jim
I like your change. :+1:

Yes, I prefer the added level. At the moment we have a view Howto’s but will it increase it will help to sort out the right one.