public inbox for documentation@lists.ipfire.org
 help / color / mirror / Atom feed
From: Carlo Fusco <fusco.carlo@gmail.com>
To: documentation@lists.ipfire.org
Subject: Need some reviews, please
Date: Thu, 15 Sep 2016 12:32:59 +0200	[thread overview]
Message-ID: <CAK9whhwosnQDdfeBHh79EZ+r8MuB7+tG+OK9cfoQZQS8gUeAdw@mail.gmail.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 2259 bytes --]

On Tue, Sep 13, 2016 at 7:24 AM, R. W. Rodolico <rodo(a)dailydata.net> wrote:
[cut]
>
> When I first started doing any documentation, I was scared to change
> anything, and I believe I caused the development team more trouble
> fixing my messups than I actually helped. Because of this, I started
> looking more closely at the "how do we document the project" idea.


thank you for doing that, as a newbie I appreciate very much this work.

>
> I reorganized http://wiki.ipfire.org/projects/docs/start slightly to put
> articles about "How to write articles" in the bottom section, "Wiki
> guideline".


from the point of view of a newbie can I make a suggestion? Can you
incorporate in the main text what is now in the link

http://wiki.ipfire.org/en/edit

In other words, make it explicit what to do. Something along this
line, Do you want to contribute to improve the documentations? First
read these links and then open an account etc..

> At Mr. Tremer's suggestion, I then read (kind of), an original document
> at http://wiki.ipfire.org/test. It is in German!
>
> NOTE: I do not speak German. I speak three languages; English, Bad
> English and Very, Very Bad Spanish. You'll note that German is not
> listed there at all. Learning to count to 29 on my grandmothers knee
> does not count as speaking German. Nor does 6 weeks of German class in
> college. This was all about Google Translate and guessing. That article
> (in Bad English) is at
> http://wiki.ipfire.org/projects/docs/quick_syntax_overview and
> desperately needs review.


I don't understand, what's wrong with this:
http://wiki.ipfire.org/wiki/syntax

which I believe is part of the standard documentation of DokuWIki. Did
you want a more synthetic document?
Regardless, I think that the links to the documentation in German
should be removed.

>
> Finally, I decided we needed some quick guidelines, so I wrote
> http://wiki.ipfire.org/projects/docs/basic_documentation_guidelines.


That's very, very nice. Thank you for doing this. As I said, as a
newbie I really appreciate this work. I didn't know about the
namespace issues you described so well, clear and to the point. I like
it.

Thanks again, including for all your help and encouragement.

-- 
Carlo Fusco



-- 
Carlo Fusco

             reply	other threads:[~2016-09-15 10:32 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-09-15 10:32 Carlo Fusco [this message]
  -- strict thread matches above, loose matches on Subject: below --
2016-09-13  5:24 R. W. Rodolico
2016-09-13 14:26 ` Michael Tremer
2016-09-15  5:18   ` R. W. Rodolico

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAK9whhwosnQDdfeBHh79EZ+r8MuB7+tG+OK9cfoQZQS8gUeAdw@mail.gmail.com \
    --to=fusco.carlo@gmail.com \
    --cc=documentation@lists.ipfire.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox