MIME-Version: 1.0
In-Reply-To: <1906580709.96391.1588956432516@mail.vodafone.de>
References: <CALci+FSVjg3rR7xfhh73QsmVHqvc+NzYrQ2Okw7WFvA_VtPYzw@mail.gmail.com>
 <1906580709.96391.1588956432516@mail.vodafone.de>
From: PICCORO McKAY Lenz <mckaygerhard@gmail.com>
Date: Fri, 8 May 2020 15:26:45 -0400
Message-ID: <CALci+FSAHChQw72h=1K6PGmrFapfC7EYiuwQcMkL+=YdwgBKYw@mail.gmail.com>
Subject: Re: lack of alpine policy of development tools, cuse lack of time for
 new collaborations
To: Al Pi <alpine@vodafonemail.de>
Cc: alpine-user <alpine-user@lists.alpinelinux.org>
Content-Type: text/plain; charset="UTF-8"

2020-05-08 12:47 GMT-04:00, Al Pi <alpine@vodafonemail.de>:
> Hello,
>
> this seems like a nice documentation writing stance,
> to keep in mind:
> (by a positive documentation example)
> https://mxmanuals.s3.us-east-2.amazonaws.com/user_manual_mx16/mxum.html#toc-Subsection-1.2

i like that! due take note of the "whose manual start how to read this
manual" that's the reason of the "use cases" wiki pages i created,
easy to read without terminology

alpine linux has many new terminology that not all "linux users" are
familiar (those winbuntu shit that thinks are linux users)

maybe the best are to advertise "you must have real knowledge of linux
before try here"

> When it comes to documentation for users,
> mixing different things side by side together on wiki pages

wikimedia are a shit! i cannot create common portions of pages to
reuse like redmine does.. and use cases are the best option for users!

by example not all the people have usb boot, also not all the users
have a rPi device.. etc etc.. so i try to created a wiki install page
for each case!

its the best for new users! already working for others projects!

> seems also hard to maintain, as it is to read, with
> redundancy even worse. That may be why organized sections
> that are kept short, and separate, as in the mxmanual
> example above are so well browseable (in the manual-browser
> preinstalled on the systems!, that havs a table of contents
> navigation on the left side), in whichever context that's needed
> by the reader.
>
> I find the alpine "Install" page organization has improved,
> but I'm not sure if some of the further things are still
> relevant. For example, if setting up apk cache is suggested
> automatically, by setup-alpine if a device is found?
>
> With a good structure, that resembles the scripts and
> tools, documenting changes could possibly be a simple
> thing for devs to check/update/remove. (Even generating a
> changelog from taged wiki edits maybe?)
> Maybe the wiki could also show a TOC on a side bar, for
> faster navigation.
>
> Kind Regards,
> -Al
>


-- 
Lenz McKAY Gerardo (PICCORO)
http://qgqlochekone.blogspot.com