[ Dekstop Help ] First Contributions - Lesson Learned

[Greg Beam]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi Doug,

Thanks for your feedback, see comments below:

On 01/12/2014 09:49 AM, Doug Smythies wrote:
> Greg: Thanks for this e-mail. There is huge value when someone new
> writes about their learning curve issues. After doing it a few
> times, one tends to develop workarounds in their brain and it
> becomes less obvious what is wrong.
> 
> Other readers should know that you dug into things so deep and
> thoroughly that it was difficult to keep up with you on IRC.
> 
> On 2014.01.12 01:35 Greg Beam wrote:
> 
>> For the experienced dev's, contributors and editors, this may be
>> white noise
> 
> Just so you know, none of us are all that experienced. The truly
> experienced and knowledgeable have left the project. We are merely
> trying to carry on.
> 
>> where the would be new contributor is left saying "this is not 
>> worth the pain!!".
> 
> We are well aware of the "not worth the pain" issue. Believe me, it
> is not limited to the "would be new contributor".
> 
>> - Tasks Tab:
> 
> Yes, brutally out of date. I wonder if one of the wiki tag experts
> (from those e-mails that I did not pay attention to) could add an
> indicator.

- -----
I think most of us in the group can add the Tags, just edit the page
and add the tag to the top.

<<Include(Tag/NeedsUpdating)>>

Tag info can be found here: https://help.ubuntu.com/community/Tag

I built a Moin Moin Wiki for local code testing, but I am not to the
point where I would take on a large page reconstruction.
- -----
> 
>> - Repository Tab: ----------------- * This page needs an
>> overhaul. It uses Natty and Karmic as examples, and points users
>> to Apps >> Accessories >> Terminal. That should have sounded
>> alarm bells, but it didn't. Blunder #1 on my part.
> 
> Yes, most of the content needs to be deleted and the reader pointed
> to the getting started pages. For my part of it, sorry. I knew that
> this page was largely redundant with the new getting started pages,
> but failed to change it.
> 
>> - Checking TAB:
> 
> Yes, we should delete its build instructions and point the reader
> to the build page and the getting started pages, or delete the page
> entirely.
> 
>> * I think using yelp (plus /path/to/ubuntu.xsl) is a very good
>> tool, but we need to document it's proper use for Desktop Help. I
>> did not use ubuntu.xsl, as I was unaware of the need, which
>> resulted in allot of re-work.

> I consider this to be partly your issue, because you already know
> so much. Just use the getting started or BUILB TAB build
> instructions and don't even think about using yelp-build directly.

- -----
Yes, one of my many blunders, but it is a nice tool. I wish we could
incorporate its use somehow.
- -----

>> * We need copyright policies clearly stated with examples.
> 
> Hence the other email thread. Lets figure it out.
> 
>> * We need Unity specific .stub files and the method to generate
>> pages.
> 
> Huh? Don't understand.

- -----
Even though we are not using yelp-build, we could still use yelp-new
to generate standard pages, index, guides, tasks etc. Can be the
normal .page or .stub for testing or whatever.

Link: https://wiki.gnome.org/Apps/Yelp/Tools/yelp-new

This could help us maintain some level of consistency, at least at
initial page generation, plus it saves coding time.

In ./ubuntu-docs do a quick: grep -R '.stub'

You'll see the files and <status="stub">
- -----

>> * We need guidance on Gnome to Unity separation, what, how much,
>> and by when, the old W3 thing (Who, What & When).
> 
> Hence the other email thread. Lets figure it out.
> 
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.15 (GNU/Linux)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBAgAGBQJS0tYDAAoJEAmfcyeKlj0x3NEIALIBEIA28uv7+fnWFabqyWu5
0b0wZjlJF8L2CmJDnYtKo5gsXHSuehVOpcL0pEOnZfiBzpEzB1ljbVKIk1V6ajrU
CCHyOypuRnSBdjeWlLGmFeZYbQmbpZZuu6UtZd6zt5QH/ClJuSSy9daerp9I++k4
5IsPaxX+N2iREHkcCY2kFP6M82aFE0kmNGVTiPppqd6LqKc+QE0/0M7n579VgEZ5
kj/nt7wrmBUDB0cSf6h1ECMvhqVsaMr8HAGM6b8dgbs1tRdfd1c0ASMGfW3MvWY7
ubI/W8fVn/Pt6VqqjucXUaZtpcWk52KBqtQQRioeucbrsyAUnh8sb0XJkY04QJ4=
=PdTm
-----END PGP SIGNATURE-----