More work on the desktop help?

classic Classic list List threaded Threaded
7 messages Options
Reply | Threaded
Open this post in threaded view
|

More work on the desktop help?

Chris Perry-2
Hi Gunnar

Can I do some more work on the desktop help? I had a look at one or
two of the ubuntu-docs bugs (link below). I had a look at the
middle-click bug #1617718 but I don't think it's possible to do an
update until Canonical give the official word on how it works. Can you
suggest anything  - not anything very difficult - that I can work on
for the desktop help? Possibly the Security & Privacy bug #1200381?
However, most of Security & Privacy looks very straightforward, so the
help might be in danger of adding nothing (to what the user can
already see on the tabs)?

Regards,

Chris.

https://bugs.launchpad.net/ubuntu/+source/ubuntu-docs


[ For anyone interested in contributing to the desktop help the
documentation is here (link below). The process is mostly
straightforward - though I got confused when trying to use the
revision control system (Bazaar).

https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuDesktopGuide

]

--
ubuntu-doc mailing list
[hidden email]
https://lists.ubuntu.com/mailman/listinfo/ubuntu-doc
Reply | Threaded
Open this post in threaded view
|

Re: More work on the desktop help?

Chris Perry-2
For anyone interested, I've checked with Gunnar and I'm now doing bug
1628706 "Revise PPA description?" (one of my bugs - but it should be
easy to do). Regards, Chris.


On 27 September 2016 at 20:04, Chris Perry <[hidden email]> wrote:

> Hi Gunnar
>
> Can I do some more work on the desktop help? I had a look at one or
> two of the ubuntu-docs bugs (link below). I had a look at the
> middle-click bug #1617718 but I don't think it's possible to do an
> update until Canonical give the official word on how it works. Can you
> suggest anything  - not anything very difficult - that I can work on
> for the desktop help? Possibly the Security & Privacy bug #1200381?
> However, most of Security & Privacy looks very straightforward, so the
> help might be in danger of adding nothing (to what the user can
> already see on the tabs)?
>
> Regards,
>
> Chris.
>
> https://bugs.launchpad.net/ubuntu/+source/ubuntu-docs
>
>
> [ For anyone interested in contributing to the desktop help the
> documentation is here (link below). The process is mostly
> straightforward - though I got confused when trying to use the
> revision control system (Bazaar).
>
> https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuDesktopGuide
>
> ]

--
ubuntu-doc mailing list
[hidden email]
https://lists.ubuntu.com/mailman/listinfo/ubuntu-doc
Reply | Threaded
Open this post in threaded view
|

Re: More work on the desktop help?

Gunnar Hjalmarsson
In reply to this post by Chris Perry-2
Hi Chris,

First I want to let others know that you already kickstarted the work
with the 17.04 desktop guide. Two bugs fixed even if 16.10 is not yet
released. Thank you for that. Great work!

On 2016-09-27 21:04, Chris Perry wrote:
> Can I do some more work on the desktop help?

Yes, of course. The desktop guide is constantly in a work in progress
state. Since the Ubuntu desktop is changing continuously, the desktop
guide will never be finished.

One approach is to simply pick existing pages or sections of pages of
your choice, check that they are still relevant and accurate, and
propose the changes you find motivated. Another thing is asking
yourself: Is there any topic which is missing? If you find there is, I
think it's a good idea to bring the idea for new page(s) up to this list
for discussion before doing too much work.

One thing worth mentioning is that many, maybe most of the pages in the
Ubuntu desktop guide origin from GNOME Help. Many of the corresponding
pages at GNOME have changed since the version we once 'merged' into the
Ubuntu desktop guide. Consequently, when checking existing pages which
origin from GNOME, one natural step is to compare with the latest GNOME
version and 'sync' if applicable. (Take
<https://launchpad.net/bugs/1624778> as an example of what I'm talking
about.)

In an attempt to organize the work, we have occasionally made use of a
spreadsheet which lists all the desktop guide pages:

https://docs.google.com/spreadsheets/d/19RdaR3G_8TQ49f-Nb0XJAwhnlweMWJqsTr4kciSV5S0/edit#gid=584037095

Maybe we should add a tab for the Z series (possibly copy the remarks
from Xenial, which were made relatively recently).

But while using such a spreadsheet is a way to document which pages got
our attention lately, the bug tracker is the principal tool for keeping
track of identified issues. Let me take a trivial example: When
completing the Swedish translations for yakkety, I found that some
original strings of a page were obsolete. At that time it was too late
to change the original content for yakkety, so I filed the bug report
mentioned above in order to remember it. (And now you've fixed it.)

So let's file bugs! (And fix them also...)

Talking about bugs, there are a couple of dozen of those which are still
open. Some of them are several years old. Typically the old open bugs
are not trivial to fix; there is often a need to do some research. Such
research is part of working with the desktop guide, so don't hesitate to
get your teeth into one of those bugs.

> I had a look at the middle-click bug #1617718 but I don't think it's
> possible to do an update until Canonical give the official word on
> how it works.

That's a good example of a bug where research is needed; in this case we
need expertise input.

> Possibly the Security & Privacy bug #1200381? However, most of
> Security & Privacy looks very straightforward, so the help might be
> in danger of adding nothing (to what the user can already see on the
> tabs)?

Yeah, I hear that you don't think it's a high priority bug, and
personally I agree.

> For anyone interested in contributing to the desktop help the
> documentation is here (link below). The process is mostly
> straightforward - though I got confused when trying to use the
> revision control system (Bazaar).
>
> https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuDesktopGuide

My impression is that you have a good grasp of the basics by now. You
hadn't worked with a version control system before, and there is a
learning curve. When you stumbled on a few things, you asked by private
mail, and that's perfectly fine.

Since you mentioned that guide, I'd like to ask you to consider if there
is room for improvements. You just submitted your first merge proposals,
so it's a perfect time to use that experience as a base for adjusting
the guide if necessary.


Last but not least: Keep taking initiatives like you've done so far, and
keep asking questions.

Thanks for joining the documentation team!

--
Gunnar Hjalmarsson
https://launchpad.net/~gunnarhj

--
ubuntu-doc mailing list
[hidden email]
https://lists.ubuntu.com/mailman/listinfo/ubuntu-doc
Reply | Threaded
Open this post in threaded view
|

Re: More work on the desktop help?

Jeremy Bicha-2
On Fri, Sep 30, 2016 at 4:24 PM, Gunnar Hjalmarsson <[hidden email]> wrote:
> One thing worth mentioning is that many, maybe most of the pages in the
> Ubuntu desktop guide origin from GNOME Help. Many of the corresponding
> pages at GNOME have changed since the version we once 'merged' into the
> Ubuntu desktop guide. Consequently, when checking existing pages which
> origin from GNOME, one natural step is to compare with the latest GNOME
> version and 'sync' if applicable. (Take
> <https://launchpad.net/bugs/1624778> as an example of what I'm talking
> about.)

If you are doing a lot of this, I found the Meld app to be helpful for
merging changes from the gnome-user-docs branch.

Thanks,
Jeremy Bicha

--
ubuntu-doc mailing list
[hidden email]
https://lists.ubuntu.com/mailman/listinfo/ubuntu-doc
Reply | Threaded
Open this post in threaded view
|

Re: More work on the desktop help?

Gunnar Hjalmarsson
On 2016-09-30 23:51, Jeremy Bicha wrote:

> On Fri, Sep 30, 2016 at 4:24 PM, Gunnar Hjalmarsson
> <[hidden email]> wrote:
>> One thing worth mentioning is that many, maybe most of the pages in
>> the Ubuntu desktop guide origin from GNOME Help. Many of the
>> corresponding pages at GNOME have changed since the version we once
>> 'merged' into the Ubuntu desktop guide. Consequently, when checking
>> existing pages which origin from GNOME, one natural step is to
>> compare with the latest GNOME version and 'sync' if applicable.
>> (Take <https://launchpad.net/bugs/1624778> as an example of what
>> I'm talking about.)
>
> If you are doing a lot of this, I found the Meld app to be helpful
> for merging changes from the gnome-user-docs branch.

Thanks for the tip, Jeremy. From a quick glance at
<http://meldmerge.org> it looks interesting, and it's available in the
Ubuntu archive as the package meld. When you were actively involved in
this, did such merges go both ways, i.e. resulted they in updates also
of <https://github.com/GNOME/gnome-user-docs>?

--
Gunnar Hjalmarsson
https://launchpad.net/~gunnarhj

--
ubuntu-doc mailing list
[hidden email]
https://lists.ubuntu.com/mailman/listinfo/ubuntu-doc
Reply | Threaded
Open this post in threaded view
|

Re: More work on the desktop help?

Chris Perry-2
In reply to this post by Gunnar Hjalmarsson
Hi Gunnar

Thanks for your reply. It's useful. I'm not going to respond to all
your points but I'll respond to some.

Regarding bug reports. Yes I like them, in part because then the
problem (assuming it's a genuine problem) is publicly documented. So
yes I agree: "So let's file bugs! (And fix them also...)".

Regarding "Typically the old open bugs are not trivial to fix". Yes I
agree. For example, sometimes a bug requires input from a developer.
For the present I won't be attempting the difficult bugs.

Regarding:

https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuDesktopGuide

yes I'll try to revise the description of how to use Bazaar.

Regarding the desktop help, I'll probably focus on small updates,
fixing things that could (in my opinion) confuse users. (At present
I'm not planning to rewrite pages - assuming there exist pages that
need rewriting.) For the present at least I'll check with you before I
do the work (as I've done with my first two merge proposals).

Thanks for your help,

Chris.

On 30 September 2016 at 21:24, Gunnar Hjalmarsson <[hidden email]> wrote:

> Hi Chris,
>
> First I want to let others know that you already kickstarted the work
> with the 17.04 desktop guide. Two bugs fixed even if 16.10 is not yet
> released. Thank you for that. Great work!
>
> On 2016-09-27 21:04, Chris Perry wrote:
>> Can I do some more work on the desktop help?
>
> Yes, of course. The desktop guide is constantly in a work in progress
> state. Since the Ubuntu desktop is changing continuously, the desktop
> guide will never be finished.
>
> One approach is to simply pick existing pages or sections of pages of
> your choice, check that they are still relevant and accurate, and
> propose the changes you find motivated. Another thing is asking
> yourself: Is there any topic which is missing? If you find there is, I
> think it's a good idea to bring the idea for new page(s) up to this list
> for discussion before doing too much work.
>
> One thing worth mentioning is that many, maybe most of the pages in the
> Ubuntu desktop guide origin from GNOME Help. Many of the corresponding
> pages at GNOME have changed since the version we once 'merged' into the
> Ubuntu desktop guide. Consequently, when checking existing pages which
> origin from GNOME, one natural step is to compare with the latest GNOME
> version and 'sync' if applicable. (Take
> <https://launchpad.net/bugs/1624778> as an example of what I'm talking
> about.)
>
> In an attempt to organize the work, we have occasionally made use of a
> spreadsheet which lists all the desktop guide pages:
>
> https://docs.google.com/spreadsheets/d/19RdaR3G_8TQ49f-Nb0XJAwhnlweMWJqsTr4kciSV5S0/edit#gid=584037095
>
> Maybe we should add a tab for the Z series (possibly copy the remarks
> from Xenial, which were made relatively recently).
>
> But while using such a spreadsheet is a way to document which pages got
> our attention lately, the bug tracker is the principal tool for keeping
> track of identified issues. Let me take a trivial example: When
> completing the Swedish translations for yakkety, I found that some
> original strings of a page were obsolete. At that time it was too late
> to change the original content for yakkety, so I filed the bug report
> mentioned above in order to remember it. (And now you've fixed it.)
>
> So let's file bugs! (And fix them also...)
>
> Talking about bugs, there are a couple of dozen of those which are still
> open. Some of them are several years old. Typically the old open bugs
> are not trivial to fix; there is often a need to do some research. Such
> research is part of working with the desktop guide, so don't hesitate to
> get your teeth into one of those bugs.
>
>> I had a look at the middle-click bug #1617718 but I don't think it's
>> possible to do an update until Canonical give the official word on
>> how it works.
>
> That's a good example of a bug where research is needed; in this case we
> need expertise input.
>
>> Possibly the Security & Privacy bug #1200381? However, most of
>> Security & Privacy looks very straightforward, so the help might be
>> in danger of adding nothing (to what the user can already see on the
>> tabs)?
>
> Yeah, I hear that you don't think it's a high priority bug, and
> personally I agree.
>
>> For anyone interested in contributing to the desktop help the
>> documentation is here (link below). The process is mostly
>> straightforward - though I got confused when trying to use the
>> revision control system (Bazaar).
>>
>> https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuDesktopGuide
>
> My impression is that you have a good grasp of the basics by now. You
> hadn't worked with a version control system before, and there is a
> learning curve. When you stumbled on a few things, you asked by private
> mail, and that's perfectly fine.
>
> Since you mentioned that guide, I'd like to ask you to consider if there
> is room for improvements. You just submitted your first merge proposals,
> so it's a perfect time to use that experience as a base for adjusting
> the guide if necessary.
>
>
> Last but not least: Keep taking initiatives like you've done so far, and
> keep asking questions.
>
> Thanks for joining the documentation team!
>
> --
> Gunnar Hjalmarsson
> https://launchpad.net/~gunnarhj

--
ubuntu-doc mailing list
[hidden email]
https://lists.ubuntu.com/mailman/listinfo/ubuntu-doc
Reply | Threaded
Open this post in threaded view
|

Re: More work on the desktop help?

Jeremy Bicha-2
In reply to this post by Gunnar Hjalmarsson
On Fri, Sep 30, 2016 at 9:23 PM, Gunnar Hjalmarsson <[hidden email]> wrote:
> Thanks for the tip, Jeremy. From a quick glance at
> <http://meldmerge.org> it looks interesting, and it's available in the
> Ubuntu archive as the package meld. When you were actively involved in
> this, did such merges go both ways, i.e. resulted they in updates also
> of <https://github.com/GNOME/gnome-user-docs>?

Yes, when I did docs, I pushed changes to
git.gnome.org/gnome-user-docs . It's fairly easy to get commit rights
there for someone who starts pushing stuff there.

One of the biggest changes since then is that Ubuntu has forked an
older version of the Settings app (unity-control-center) so there
isn't nearly as much that needs to be looked at for merging.
unity-control-center hasn't changed much either in a while.

Jeremy

--
ubuntu-doc mailing list
[hidden email]
https://lists.ubuntu.com/mailman/listinfo/ubuntu-doc