We must organize the doc

I don’t want to leave @stephdl alone in this task. How can we join our forces @AbsyntH, @sitz, @Ctek, @stephdl, @WillZen, @Jim ?
May we write down a list of suggested new docs?

We can still use community to discuss new docs on the wiki, opening a new discussion and asking others thoughts

1 Like

Just a tip, really obvious, but in the wiki you can create your own personal page, like mine, it is a simple way to write note

One easy way to create your wiki page, go to the recent change and clic on your name or go to the upper side of the wiki and look after ‘Logged in as’ and clic on the link

3 Likes

Guys, this discussion was really interesting and engaging but I’m sad today to see so few changes over the months
http://wiki.nethserver.org/doku.php?id=start&do=recent
How can we take up the discussion? @AbsyntH, @sitz, @Ctek, @stephdl, @WillZen, @Jim any idea?

I think individual package reference documentation should be inside the package git repository. It would ease the development task of updating the documentation together with code changes.

So pages like this

http://docs.nethserver.org/projects/nethserver-devel/en/latest/ups.html

I think they should be moved into README files, like this (old experiment)

https://github.com/NethServer/nethserver-sogo/blob/master/README.rst

Good idea but I’d like to focus our forces on wiki too!

Fill the wiki !

@stephdl
How do I move my HowTo from my page to the front?

Could someone from the docuteem (@AbsyntH, @sitz, @stephdl, @Jim) have a look on what I wrote if it ok or need some improvement.
http://wiki.nethserver.org/doku.php?id=user:willzen

3 Likes

I’m not vpn user, but your page look good and ilustrations are greats

I will try the procedure :wink:

As we moved to github, I think coud be a good idea. BUT it’s a huge work. Just quick points we need to address before starting a work like this:

  • we currently have developer info split into 4 places: some READMEs (I don’t know why), developer manual, wiki and old wiki (NethServer 6 - NethServer.org)
  • if we move all inside the README, there will be some information hard to categorize, like the general part about templates and events
  • if we splitt the documentation across many repository, it will be much more difficult to find
  • we need to have at least one or two people who take care of the whole effort and make it done in a reasonable amount of time

Maybe we can move all the developer doc to the wiki, but this requires the same effort.

I’m open to suggestion, but please do not shred into pieces the dev doc.

/cc @alefattorini @fasttech @stephdl @AbsyntH @Jim

I’m not officially from the docuteam…but great work on VPN!

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: