Re: [arch-general] What is the current wiki-poliicy for re-writing contributions?

2016-03-22 Thread Maxwell Anselm
>
>   Under what criteria does this take place? It has gotten to the point
> where you
> just get tired of helping -- why bother?


The main criterion is this:
https://wiki.archlinux.org/index.php/Help:Style#Hypertext_metaphor

Specifically, "Before writing a specific procedure in an article or
describing something in particular, always check if there is already an
article that treats that part in detail: in that case, link that article
instead of duplicating its content."

This is not some conspiracy to "obfuscate information as much as possible",
it is a matter of practicality for maintaining the wiki. I see the
usefulness of all-in-one tutorials that users can simply read from start to
finish, but such tutorials come with their own problems:

   - They often duplicate content from multiple articles. That means that
   they can quickly become inaccurate as other articles are updated, making
   wiki maintenance much harder.
   - They have to balance between simple/general and complex/specific. A
   general tutorial is most likely going to omit important information for
   some users, leaving some users struggling with errors or missing
   functionality. However a more specific tutorial becomes bloated as it tries
   to address corner cases, making it harder to read, and even more
   susceptible to the problem of article duplication.
   - By providing a "one-stop shop" they discourage users from reading
   important articles. The fact is that some aspects of Arch Linux are just
   complicated: they might require reading multiple long, complicated wiki
   articles in order to understand them. Every time you say "Just do X, Y, and
   Z" without giving the full context of these actions, you are sacrificing
   short-term readability for potentially more confused users in the long
   term. See also
   https://wiki.archlinux.org/index.php/Arch_Linux#User_centrality.

For example, take this discussion prompted by one of my big reverts of the
AUR article: 
https://wiki.archlinux.org/index.php/Talk:Arch_User_Repository#Uploading_AUR_Packages.2C_AUR
articlclear_and_consise.2C_reverted_edit:
.
Someone wanted to make the AUR article easier to read for new maintainers
by adding a quick git intro for AUR4. Being an AUR maintainer means you
need some familiarity with git, so this quick intro objectively made the
article easier to read. So why did I revert it? Having worked with git
professionally for years and having taught git to many, many people I know
that it can be an extremely confusing tool even for people already familiar
with other version control tools. Looking at that intro, I could picture
the hoards of confused new AUR maintainers in the AUR subforum with
horribly mangled git repositories on their hands because their only
introduction to git was a tiny subsection of the AUR article. Being an AUR
maintainer means using git, and git is complicated, so you need to take
some time to learn it. Is that bad writing? Is that obfuscation? Is that
elitist? I think it's just the way things are.

All of that being said, I am not against including tutorial-like articles
on the wiki. As long as they are clearly marked and kept separate from the
main reference articles, I see no problem. I particularly like Kenneth's
idea of having a Tutorial sub-article e.g.
https://wiki.archlinux.org/index.php/Arch_User_Repository/Tutorial. It
would be even better if we could add a Template:Tutorial to such articles
like "This tutorial may not cover every use-case. Consult the main article
for comprehensive information and troubleshooting."

Max


Re: [arch-general] What is the current wiki-poliicy for re-writing contributions?

2016-03-22 Thread Kenneth Jensen
On Mar 22, 2016 3:26 AM, "Jayesh Badwaik" 
wrote:
>
> Initially, when the wiki was small, a page would have a small section,
with
> instructions to get a basic system running. Now, probably as the wiki has
> grown more comprehensive, it is becoming more and more reference-based
> and the tutorial like properties are disappearing.
>
> May be it would nice if people would start writing tutorial like articles
> for simple enough uses. For example see [1].
>
> --
> Cheers
> Jayesh Badwaik
>
> [1] https://wiki.archlinux.org/index.php/Simple_stateful_firewall

Perhaps there could be a tutorial section for aetting up the basics, and a
reference section. Or seperate pages, such as Program/Tutorial for setting
up and Program as reference.


Re: [arch-general] What is the current wiki-poliicy for re-writing contributions?

2016-03-22 Thread Frank Schaffhaeuser

--- On Tue, 22 Mar 2016 08:26:15 + Jayesh Badwaik 
archli...@jayeshbadwaik.in wrote  

On Tuesday, 22 March 2016 09:00:28 IST Jan Alexander Steffens wrote: 
 I hardly look at the wiki anymore, but I remember getting the same 
 impression—most recently I had to hunt through multiple pages about 
 encryption to get even a basic setup going. 
 
 This is a problem. 
 
Initially, when the wiki was small, a page would have a small section, with 
instructions to get a basic system running. Now, probably as the wiki has 
grown more comprehensive, it is becoming more and more reference-based 
and the tutorial like properties are disappearing. 
 
May be it would nice if people would start writing tutorial like articles 
for simple enough uses. For example see [1]. 
 
-- 
Cheers 
Jayesh Badwaik 
 
[1] https://wiki.archlinux.org/index.php/Simple_stateful_firewall 

Exactly. It almost looks like it's done on purpose, to obfuscate information as
much as possible. This would neatly reflect the elitist mindset of many arch 
users
one comes across on the internet. My prime example is the 'Beginners
Guide' from the wiki; I have an old version from around July 2015 as an
installation checklist, to prevent me from forgetting any important steps.
Thank $DEITY i have that printed on paper.
Today it's completely watered down and littered with links. That guide is, as
the name suggests, for 'beginners'. Many explanations have been stripped
or are hidden behind links. You can't just print it, start the installation and 
be 
done in 30 minutes. No, now you either need a second machine to 'browse' the
wiki or memorise the whole process.
I'm afraid your suggestion to write tutorial like articles may appear too
'Ubuntu-esque' for some wiki editors...





Re: [arch-general] What is the current wiki-poliicy for re-writing contributions?

2016-03-22 Thread Jayesh Badwaik
On Tuesday, 22 March 2016 09:00:28 IST Jan Alexander Steffens wrote:
> I hardly look at the wiki anymore, but I remember getting the same
> impression—most recently I had to hunt through multiple pages about
> encryption to get even a basic setup going.
> 
> This is a problem.

Initially, when the wiki was small, a page would have a small section, with 
instructions to get a basic system running. Now, probably as the wiki has 
grown more comprehensive, it is becoming more and more reference-based 
and the tutorial like properties are disappearing. 

May be it would nice if people would start writing tutorial like articles 
for simple enough uses. For example see [1]. 

-- 
Cheers
Jayesh Badwaik

[1] https://wiki.archlinux.org/index.php/Simple_stateful_firewall


Re: [arch-general] What is the current wiki-poliicy for re-writing contributions?

2016-03-22 Thread Jan Alexander Steffens
On Mon, Mar 21, 2016 at 6:22 PM, David C. Rankin
 wrote:
>   When I first began using Arch in '09, the pages were written such that you
> could fully-complete whatever task the page addressed without bouncing around
> from page-to-page hunting for all the pieces of the puzzle. That is no longer
> the case.

I hardly look at the wiki anymore, but I remember getting the same
impression—most recently I had to hunt through multiple pages about
encryption to get even a basic setup going.

This is a problem.