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

[Chris Perry]

This all seemed pretty straightforward.

The terminology situation is a bit messy. Eg I noticed that the gui uses "start-up" at one point but I've used "startup" throughout. I've used "USB flash drive" not "USB stick", etc. I've used "CD image" not "ISO file", etc.

I like to give indications of time, where it's possible to do so. Here it is and I have: "ten minutes or less".

I haven't reminded the user to (safely) eject the USB flash drive. Perhaps I should?

[Doug Smythies (dsmythies)]

Hi Chris,

Thanks for your continuing good work on the help docs.
This MP seems to include the previous MP, which is O.K., I guess.

Since you are adding a new file the revision version should be set accordingly.
You will also need to edit Makefile.am and add the file.

I'll actually build the docs and look at the content later.

review: Needs Fixing

[lp:~clissold345/ubuntu-docs/fix-for-1569532]

587. By Chris Perry on 2017-01-02

Describe the Startup Disk Creator; LP: #1569532

[Chris Perry (clissold345)]

Hi Doug, thanks for your reply. Yes I've set revision to 17.04 (since that's the release the page will be released in). Is that correct? I've also set the date to today's date. Is that correct? Yes I've updated Makefile.am. My two merge proposals are independent so presumably there's no reason why (once approved) one can't be merged in without the other?

[Gunnar Hjalmarsson (gunnarhj)]

Besides Doug's comment, which I agree on, I don't think that this page fits well in the "Install & remove software" section. I would suggest that it's renamed and placed in the "Disks & storage" section instead, which deals with things affecting whole partitions.

As regards the contents, the term "CD image" sounds a bit dated considering that most images don't fit on a CD nowadays. I suggest "DVD image" or just "image". Also, I think that the term "ISO file" should be mentioned at least once.

These are the changes I propose:

gunnar@gunnar-ubuntu-current:/media/gunnar/ubuntu-dev/home/gunnar/UbuntuDev/bzr/ubuntu-docs/trunk/ubuntu-help/C$ diff -u addremove-creator.page disk-creator.page
--- addremove-creator.page 2017-01-02 20:41:02.965027000 +0100
+++ disk-creator.page 2017-01-02 21:54:22.961657670 +0100
@@ -1,6 +1,6 @@
 <page xmlns="http://projectmallard.org/1.0/"
       type="topic" style="task"
- id="addremove-create">
+ id="disk-creator">

   <info>
     <credit type="author">
@@ -12,8 +12,7 @@
     </desc>

     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
- <link type="guide" xref="addremove" group="#first"/>
- <link type="seealso" xref="addremove-install-synaptic"/>
+ <link type="guide" xref="disk"/>
     <revision version="16.04" date="2016-03-13" status="review"/>
   </info>

@@ -25,9 +24,9 @@
   The capacity of the USB flash drive must be at least 2 GB.
   Any data on the USB flash drive will be lost when you create the startup disk.</p>

- <p>It's assumed that you have downloaded an Ubuntu CD image.</p>
+ <p>It's assumed that you have downloaded an Ubuntu image (ISO file).</p>

- <p>To create a startup disk from an Ubuntu CD image:</p>
+ <p>To create a startup disk from an Ubuntu image:</p>

   <steps>
     <item>
@@ -37,8 +36,8 @@
     </item>
     <item>
       <p>
- If the CD image is in your <gui>Download</gui> folder and there is just one CD image, <app>Startup Disk Creator</app> will have selected it,
- otherwise select the correct CD image.
+ If the image is in your <gui>Download</gui> folder and there is just one image, <app>Startup Disk Creator</app> will have selected it,
+ otherwise select the correct image.
       </p>
     </item>
     <item>

review: Needs Fixing

[Chris Perry (clissold345)]

Hi Gunnar, thanks for your reply. Your points about "CD image" and "ISO file" are fine. I haven't read all of the diff output but I'm assuming there's nothing in it that you didn't mention in your first two paragraphs.

I'm fine to have a link to the new page on disk.html but I'd argue that the link I (in effect) added on addremove.html makes sense too - because the ultimate task for many of the people who want to create a startup disk is to install software (that is, to install Ubuntu). (I'll probably revise my new page slightly to make it clear that one can install Ubuntu using a startup disk.) What do you think?

Presumably it's not a problem to link to a page from two "menu" pages? If necessary we just have two copies of the page?

[Gunnar Hjalmarsson (gunnarhj)]

Even if you in the next step 'install software' in a sense, I still think it's a bit far-fetched. But ok, there is no obvious place in the current structure for this page, so let's link from both. But it shouldn't be the first item under "Install & remove software", so I think the group value should be "#last" instead of "#first".

<link type="guide" xref="disk"/>
<link type="guide" xref="addremove" group="#last"/>

I agree that installing Ubuntu should be mentioned somehow. Maybe by including a link to <https://www.ubuntu.com/download/desktop/install-ubuntu-desktop>.

[lp:~clissold345/ubuntu-docs/fix-for-1569532]

588. By Chris Perry on 2017-01-03

Describe the Startup Disk Creator; LP: #1569532

[Chris Perry (clissold345)]

Hi Gunnar, thanks for taking the time to review this.

Wikipedia likes "ISO image" so I've used that term - but for the first two uses I've expanded it to "Ubuntu ISO image".

https://en.wikipedia.org/wiki/ISO_image

Initially I misunderstood one of your comments and thought I had to change addremove.page. I seem to have accidentally added a blank line to addremove.page - but it doesn't matter if that change goes in or not.

The new page (addremove-create.page) is now on both "menu" pages, etc.

I hope I've covered everything.

[lp:~clissold345/ubuntu-docs/fix-for-1569532]

589. By Chris Perry on 2017-01-03

Describe the Startup Disk Creator; LP: #1569532

[Chris Perry (clissold345)]

One more change: I removed the "see also" link, which comes from the page I copied and is not needed here.

[Gunnar Hjalmarsson (gunnarhj)]

One tiny detail: Please change the page id from "addremove-create" to "addremove-creator" so it matches the file name.

Besides that it looks good, so assuming that you make that change before pushing I approve now.

Thanks!

review: Approve

[Chris Perry (clissold345)]

Thanks. I've made the change and pushed to trunk. bzr says "Pushed up to revision 590".

=== added file 'ubuntu-help/C/addremove-creator.page'
--- ubuntu-help/C/addremove-creator.page	1970-01-01 00:00:00 +0000
+++ ubuntu-help/C/addremove-creator.page	2017-01-03 22:30:38 +0000
@@ -0,0 +1,73 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      type="topic" style="task"
+      id="addremove-create">
+
+  <info>
+    <credit type="author">
+      <name>Ubuntu Documentation Team</name>
+    </credit>
+
+    <desc> 
+    Convert a USB flash drive into a volume from which you can startup and install Ubuntu.
+    </desc>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <link type="guide" xref="disk"/>
+    <link type="guide" xref="addremove" group="#last"/>
+
+    <revision version="17.04" date="2017-01-02" status="review"/>
+  </info>
+
+  <title>
+    Create a startup disk
+  </title>
+
+  <p>In this context a startup disk is a USB flash drive from which you can startup and <link
+    href="https://www.ubuntu.com/download/desktop/install-ubuntu-desktop">install Ubuntu</link>.
+  The capacity of the USB flash drive must be at least 2 GB.
+  Any data on the USB flash drive will be lost when you create the startup disk.</p>
+
+  <p>It's assumed that you have downloaded an Ubuntu ISO image.</p>
+
+  <p>To create a startup disk from an Ubuntu ISO image:</p>
+    
+  <steps>
+    <item>
+      <p>
+        Open <app>Startup Disk Creator</app> from the <gui>Dash</gui>.
+      </p>
+    </item>
+    <item>
+      <p>
+        If the ISO image is in your <gui>Download</gui> folder and there is just one ISO image, <app>Startup Disk Creator</app> will have selected it,
+        otherwise select the correct ISO image.
+      </p>
+    </item>
+    <item>
+      <p>
+        If your computer has just one USB flash drive, <app>Startup Disk Creator</app> will have selected it, otherwise select the correct drive.
+      </p>
+    </item>
+    <item>
+      <p>
+        Click <gui>Make Startup Disk</gui>.
+      </p>
+    </item>
+    <item>
+      <p>
+        Click <gui>Yes</gui> to confirm. The process should take ten minutes or less.
+      </p>
+    </item>
+
+    <item>
+      <p>
+        When the "Installation Complete" window opens click <gui>Quit</gui>.
+      </p>
+    </item>
+
+  </steps>
+
+
+
+</page>

=== modified file 'ubuntu-help/C/addremove.page'
--- ubuntu-help/C/addremove.page	2016-11-08 21:06:37 +0000
+++ ubuntu-help/C/addremove.page	2017-01-03 22:30:38 +0000
@@ -5,6 +5,7 @@
     <revision version="14.04" date="2013-12-26" status="review"/>
 
     <link type="guide" xref="index" group="addremove"/>
+
     <title role="trail" type="link">Add/remove software</title>
 
     <credit type="author">

=== modified file 'ubuntu-help/Makefile.am'
--- ubuntu-help/Makefile.am	2016-09-14 21:14:53 +0000
+++ ubuntu-help/Makefile.am	2017-01-03 22:30:38 +0000
@@ -60,6 +60,7 @@
 	accounts-remove.page \
 	accounts-which-application.page \
 	accounts-whyadd.page \
+	addremove-creator.page \
 	addremove-install-synaptic.page \
 	addremove-install.page \
 	addremove-ppa.page \