Merge lp:~clissold345/ubuntu-docs/fix-for-1599264 into lp:~ubuntu-core-doc/ubuntu-docs/trunk2017-07-10

Proposed by Chris Perry on 2016-10-12
Status: Merged
Merged at revision: 560
Proposed branch: lp:~clissold345/ubuntu-docs/fix-for-1599264
Merge into: lp:~ubuntu-core-doc/ubuntu-docs/trunk2017-07-10
Diff against target: 124 lines (+33/-41)
2 files modified
ubuntu-help/C/accounts-add.page (+22/-22)
ubuntu-help/C/power-lowpower.page (+11/-19)
To merge this branch: bzr merge lp:~clissold345/ubuntu-docs/fix-for-1599264
Reviewer Review Type Date Requested Status
Gunnar Hjalmarsson 2016-10-12 Approve on 2016-10-17
Review via email: mp+308231@code.launchpad.net

Description of the change

Hi Gunnar, you said you're inclined to drop the whole page. I suggest we keep it. Perhaps I shouldn't have gone ahead and done the change and proposed a merge?

I'm assuming the info in the link I found - I gave the link in the bug report - is correct (eg the action taken on power critically low is shut down, etc). The main purpose of the page (in my opinion) is to say what happens when power is critically low, and it's still useful for users to have that info. The page is short now but it doesn't look ridiculous to me.

As I understand it the shut down action is (still) the default action. It can (still) be changed from the command line (but not now from the GUI). I'd like to say that it's the default action but I can't really do that because then users may ask "What are the other actions and how do I change the default?".

What should we do?

To post a comment you must log in.
561. By Chris Perry on 2016-10-13

Small clarification of procedure

562. By Chris Perry on 2016-10-13

Revison of procedure

Chris Perry (clissold345) wrote :

Regarding the updates to accounts-add.page. I started to revise it because I thought the original writer had got a bit confused about whether he/she was "adding an account" or "adding accounts". Then I discovered that the instructions are no longer correct (at least when adding an account for Google). Eg the first button in step 5 is now "Allow" and the second button is now "Grant access" not "Grant Access". The old procedure was also wrong in a few other places (at least in the case of Google). So my version of the procedure should be more accurate than the old version.

The old page used the term "online account" and then later "online service". I think it's probably ok to use "online account" throughout.

Gunnar Hjalmarsson (gunnarhj) wrote :

Hi Chris,

I don't think it's as simple as the computer just being shut down. The Ask Ubuntu answer you linked to in the bug report is wrong or obsolete; gsettings has nothing to do with it any longer.

I think this is an applicable file:

/etc/UPower/UPower.conf

Take a look at the end of that file.

So either more research is needed, or we just let it go and delete the page. This is apparently something that is supposed to be handled behind the scenes now, and I don't think the desktop guide is the right place to describe this particular aspect of the system. The reason why the page exists is that there was a user control in system settings, but now that control is gone.

review: Needs Fixing
Chris Perry (clissold345) wrote :

Hi Gunnar

Thanks for finding the config file (/etc/UPower/UPower.conf). That looks like the info I needed!

I looked up what HybridSleep means. I think it's clear what happens when power gets critically low and I think it's useful for users to know (in outline) what happens if they leave their device running on battery and power gets critically low - though we don't need to give all the tedious details. What about this:

"If your device is running on battery only and power gets critically low, Ubuntu will enter a low-power mode in which unsaved data is saved. In such a case even if the battery runs out and your device turns off, the data will be available when you restart. If your device does not support such a mode, Ubuntu will shut down and any unsaved data will be lost".

There's also the question of where the description goes in the help - assuming we agree to have it. But that should be easy to solve. The difficult bit in my opinion is agreeing if we need the description (I think it's useful, you don't) and its wording.

What do you think?

Regards,

Chris.

Gunnar Hjalmarsson (gunnarhj) wrote :

I've had a closer look at the related pages, and have changed my mind. I think your latest suggestion sounds good and that it fits best on a separate page, i.e. the one which already exists. So can you please go ahead and change the MP accordingly.

Thanks for your persistence in this matter! ;)

563. By Chris Perry on 2016-10-17

More revisons to procedure

Chris Perry (clissold345) wrote :

I revised "Add an account" some more. Eg I found I did want to use the term "online service" after all. I tried to make the "permission" steps clearer. In the first the user tells the online service to allow Ubuntu access and in the second the user gives Ubuntu permission to access the online account. And I made other small changes too.

I'm planning to do the "power critically low" changes later today.

564. By Chris Perry on 2016-10-17

More revisions to power critically low

Chris Perry (clissold345) wrote :

Regarding "power critically low" Ive used the term "device" since the device could be a laptop, tablet or even perhaps smartphone. power critically low = 2% but I haven't stated that since that would probably be more detailed than we need to be in the desktop help.

Gunnar Hjalmarsson (gunnarhj) wrote :

Looks good now.

I changed back from "device" to "computer" when merging, though. The desktop guide only covers Ubuntu with Unity7, so "device" would just create unnecessary ambiguity. Only when we start documenting Unity8 "device" will be useful.

Thanks!

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'ubuntu-help/C/accounts-add.page'
2--- ubuntu-help/C/accounts-add.page 2014-02-15 15:26:33 +0000
3+++ ubuntu-help/C/accounts-add.page 2016-10-17 10:05:41 +0000
4@@ -32,7 +32,7 @@
5 </title>
6
7 <p>
8- Adding an account will help link your online accounts with your Ubuntu
9+ Adding an account will link one of your online accounts with your Ubuntu
10 desktop. Thus, your email, chat, and other related applications will be set
11 up for you.
12 </p>
13@@ -49,50 +49,50 @@
14 </item>
15 <item>
16 <p>
17- Select an <gui>Account Type</gui> from the right hand windowpane.
18+ Select an <gui>account type</gui> from the right-hand pane.
19 </p>
20- <note style="tip">
21- <p>
22- If you want to configure more accounts, you can repeat this process
23- afterwards.
24- </p>
25- </note>
26 </item>
27+
28 <item>
29 <p>
30 A small web user interface will open where you can enter your online
31 account credentials. For example, if you are setting up a Google
32- account, enter your Google username, password and sign in.
33+ account, enter your Google username and password and sign in.
34 </p>
35 </item>
36+
37 <item>
38 <p>
39- If you entered your credentials correctly, you will be prompted to
40- accept the terms. Select <gui>Accept</gui> to continue.
41-
42- Once accepted, Ubuntu needs permission to access your account. To allow
43- access, click on the <gui>Grant Access</gui> button. When prompted,
44- enter the current users password.
45- </p>
46- </item>
47- <item>
48+ If you entered your credentials correctly, you have to tell your online service to
49+ allow Ubuntu access to your online account. Select <gui>Allow</gui> to continue.
50+ </p>
51+ </item>
52+
53+ <item>
54+ <p>
55+ Ubuntu needs permission to access your online account. Select <gui>Grant access</gui> to continue.
56+ </p>
57+ </item>
58+
59+
60+ <item>
61 <p>
62 Now you can select the applications you want linked to your online
63- account. For example, if you want to use an online account for chat,
64+ account. For example, if you want to use an account for chat,
65 but do not want the calendar, turn the <gui>calendar</gui> option off.
66 </p>
67 </item>
68 </steps>
69 <p>
70- After you have added the accounts, each application you have selected will
71- automatically use those credentials when you log into your account.
72+ After you have added an account, each application you have selected will
73+ automatically use those credentials when accessing the online account.
74 </p>
75 <note style="tip">
76 <p>
77 For security reasons, Ubuntu will not store your password on your
78 computer. Instead, it stores a token that is provided by the online
79 service. If you want to fully revoke the link between your desktop and the
80- online service, <link xref="accounts-remove">remove</link> it.
81+ online account, <link xref="accounts-remove">remove</link> it.
82 </p>
83 </note>
84 </page>
85
86=== modified file 'ubuntu-help/C/power-lowpower.page'
87--- ubuntu-help/C/power-lowpower.page 2014-02-15 08:14:22 +0000
88+++ ubuntu-help/C/power-lowpower.page 2016-10-17 10:05:41 +0000
89@@ -20,24 +20,16 @@
90 <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
91 </info>
92
93-<title>Why did my computer turn off/suspend when the battery got to 10%?</title>
94-
95-<p>When the charge level of the battery gets too low, your computer will
96-automatically <link xref="power-suspend">suspend</link>. It does this to
97-make sure that the battery doesn't completely discharge, since this is bad for
98-the battery. If the battery just ran out, the computer wouldn't have time to
99-shut down properly either.</p>
100-
101-<p>You can change what happens when the battery level gets too low. First, click the
102-<gui>battery menu</gui> in the <gui>menu bar</gui> and select <gui>Power Settings</gui>. At the <gui>'When
103-power is critically low'</gui> setting, you can choose for the computer to
104-suspend, <link xref="power-hibernate">hibernate</link>, or shut down. If you choose shut down, your applications and
105-documents <em>will not</em> be saved when the computer turns off.</p>
106-
107-<p>Some computers have problems suspending, and may not be able to recover the
108-applications and documents you had open when you turn on the computer again. In
109-this case, it is possible that you could lose some of your work if you didn't
110-save it before the computer suspended. You may be able to <link
111-xref="power-suspendfail">fix problems with suspend</link> though.</p>
112+<title>Why did my device shut down when power got critically low?</title>
113+
114+<p>
115+
116+If your device is running on battery only and power gets critically low,
117+Ubuntu will enter a low-power mode in which unsaved data is saved.
118+In such a case even if the battery runs out and your device turns off,
119+the data will be available when you restart. If your device does not
120+support such a mode, Ubuntu will shut down and any unsaved data will be lost.
121+
122+</p>
123
124 </page>

Subscribers

People subscribed via source and target branches