please move ubuntu-help/ to gnome-help/

Bug #1686267 reported by Jeremy Bicha
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
ubuntu-docs (Ubuntu)
Fix Released
High
Gunnar Hjalmarsson

Bug Description

For Ubuntu 17.04 and earlier, we patched several (but not all) GNOME apps to show help:ubuntu-help when run in Unity but still show help:gnome-help when run in GNOME.

That won't work anymore with 17.10.

Test Case
---------
You can see this by installing gnome-shell then logging into GNOME. (It's probably easiest to choose lightdm if asked unless you install ubuntu-gnome-desktop because of LP: #1686257 )

Open the Help app. It should display either Ubuntu's Help or GNOME's Help but it instead loads the All Help page because it can't find help:gnome-help.

Easy Suggested Fix
------------------
bzr mv ubuntu-help gnome-help

Be sure to set Conflicts: gnome-user-guide

Then we probably need to change all the places that point to help:ubuntu-help to point to help:gnome-help unless someone really wants to maintain a Unity Help Guide.

Alternate Suggested Fix
-----------------------
We could just install gnome-user-guide instead of ubuntu-docs.

Depending on how much customization is wanted, you could fork gnome-user-guide later.

And update help:ubuntu-help links to help:gnome-help like in the previous fix.

Later
----
I think we'll eventually want a transitional package once we figure out what package name we're going to stick with.

Tags: gnome-17.10
Jeremy Bicha (jbicha)
tags: added: gnome-17.10
Revision history for this message
Gunnar Hjalmarsson (gunnarhj) wrote :

Hi Jeremy,

I saw your upload at

https://launchpad.net/ubuntu/+source/gnome-control-center/1:3.24.1-0ubuntu3

Thanks for making it easier to first try to maintain the ubuntu-docs branch.

I think the changes I uploaded address this bug. So far I have assumed that we keep the translation domain "ubuntu-help", and I suppose that there is no problem to keep "ubuntu-help" in the URL at help.ubuntu.com if that's what we want.

The package does not conflict to gnome-getting-started-docs - I assume they can well co-exist, and that we have the option to integrate gnome-getting-started-docs in ubuntu-docs in the same manner as it's currently integrated in gnome-user-guide.

There are quite a few things I'm not sure of at this time. Hopefully we'll be able to sort them out in a sensible manner. As a last resort I suppose it wouldn't be very difficult to switch to gnome-user-guide late in the cycle.

Changed in ubuntu-docs (Ubuntu):
assignee: nobody → Gunnar Hjalmarsson (gunnarhj)
status: New → Fix Committed
Revision history for this message
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package ubuntu-docs - 17.10.1

---------------
ubuntu-docs (17.10.1) artful; urgency=medium

  * Bump version to 17.10 / artful.
  * Replace "ubuntu-help" with "gnome-help" (LP: #1686267):
    - Rename the branch folder, and make the .page files install in
      /usr/share/help/<lang>/gnome-help.
    - Make ubuntu-docs conflict gnome-user-guide.

 -- Gunnar Hjalmarsson <email address hidden> Wed, 26 Apr 2017 16:56:00 +0200

Changed in ubuntu-docs (Ubuntu):
status: Fix Committed → Fix Released
Revision history for this message
Jeremy Bicha (jbicha) wrote :

Thanks Gunnar.

You can install gnome-getting-started-docs now if you have an artful install. When I tested, it showed up as an extra section at the bottom of the main Help page.

If we use gnome-initial-setup, by default it opens the Getting Started help after the user completes the setup questions.

If you like those 2 packages (getting-started and initial-setup), I can file the Main Inclusion Requests.

Yes, we could still switch to gnome-user-guide later. I think it would be good to decide which package to use before 17.10 Artful is released, but you might want to wait until closer to Feature or UI Freeze?

Revision history for this message
Gunnar Hjalmarsson (gunnarhj) wrote :

On 2017-04-26 22:16, Jeremy Bicha wrote:
> You can install gnome-getting-started-docs now if you have an artful
> install.

Right, I tested it.

> When I tested, it showed up as an extra section at the bottom of the
> main Help page.

Cool, missed that detail before. :)

> If we use gnome-initial-setup, by default it opens the Getting
> Started help after the user completes the setup questions.
>
> If you like those 2 packages (getting-started and initial-setup), I
> can file the Main Inclusion Requests.

As regards gnome-initial-setup, it's a design matter a bit beyond the docs internals, and I would suggest a separate thread about it on the ubuntu-desktop mailing list.

Ubuntu MATE has something along those lines, and if we keep lightdm, it can be worth mentioning that they show a customized first page in the guest session.

> Yes, we could still switch to gnome-user-guide later. I think it
> would be good to decide which package to use before 17.10 Artful is
> released, but you might want to wait until closer to Feature or UI
> Freeze?

Something like that. I'd like to make a serious attempt to fork the .page files from a suitable version (which version is that?) of GNOME Help, identify the Ubuntu specific pages which would make sense to keep, and integrate them in the structure.

Revision history for this message
Jeremy Bicha (jbicha) wrote :

> a suitable version

Either 3.24.0 already in Zesty/Artful or git master

https://git.gnome.org/browse/gnome-user-docs/log

Yes, the Ubuntu Desktop Team will discuss the Initial Setup app later.

Even before Ubuntu GNOME finally got gnome-initial-setup packaged and in the default install, we had the Getting Started Help show up on first login.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers