Ubuntu Documentation

Merge lp:~dsmythies/ubuntu-docs/help.ubuntu.com-infastructure into lp:~ubuntu-core-doc/help.ubuntu.com/help.ubuntu.com2017-07-21

  1. help.ubuntu.com-infastructure
  2. Merge into help.ubuntu.com2017-07-21
Proposed by Doug Smythies
Status: Merged
Approved by: Doug Smythies
Approved revision: 172
Merged at revision: 170
Proposed branch: lp:~dsmythies/ubuntu-docs/help.ubuntu.com-infastructure
Merge into: lp:~ubuntu-core-doc/help.ubuntu.com/help.ubuntu.com2017-07-21
Diff against target: 107 lines (+29/-8)
3 files modified
14.10/index.html (+13/-4)
htdocs/robots.txt (+1/-0)
stable/index.html (+15/-4)
To merge this branch: bzr merge lp:~dsmythies/ubuntu-docs/help.ubuntu.com-infastructure
Reviewer Review Type Date Requested Status
Gunnar Hjalmarsson Approve
Peter Matulis Pending
Review via email: mp+246359@code.launchpad.net

Description of the change

Some changes for the new Canonical cloudocs section:
A directive rule addition to robots.txt
A symlink to handle requests for stable
A couple of links added to a couple of index.html files.

I can not test this fully on my local copy of help.ubuntu.com as I do not have the clouddocs stuff.

To post a comment you must log in.
Revision history for this message
Gunnar Hjalmarsson (gunnarhj) wrote :

Looks good - worth a try.

review: Approve
Revision history for this message
Doug Smythies (dsmythies) wrote :

Peter: I would appreciate your opinion on this one.

I'll wait a day before merging.

Revision history for this message
Peter Matulis (petermatulis) wrote :

The Cloud docs are 14.04 specific. We should not give readers the impression that they can follow them using 14.10.

Revision history for this message
Doug Smythies (dsmythies) wrote :

Peter: Is your preference to delete the additional lines from the 14.10/index.html file or to make the added lines clearer?

The way we are heading, the file will only really be visible for 3 months anyhow, so I guess it isn't a big deal either way.

Revision history for this message
Peter Matulis (petermatulis) wrote :

My preference is to remove.

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

On 2015-01-14 17:31, Peter Matulis wrote:
> My preference is to remove.

I'm thinking (yes, it happens):

If somebody is using the 14.10 cloud software and looks for docs, s/he might then go to 14.10/stable and find nothing. Wouldn't it be better with a statement that the available docs are 14.04 specific, and provide a link to it?

Revision history for this message
Doug Smythies (dsmythies) wrote :

Then I think this whole MP becomes moot.

I was just trying to cover the scenario, as was done for the serverguide, where the best document for the 14.10 case is the 14.04 version because nothing better exists.

I'll delete this MP later on.

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

I'm not following you now, Doug. Why would you do that? I just advocated your idea to "make the added lines clearer".

Revision history for this message
Doug Smythies (dsmythies) wrote :

Gunnar: I had not seen your post when I posted. Sorry for the confusion.

I have since decided that the robots.txt part is needed anyhow, if for no other reason than the once every 2 years when LTS=STABLE.

I prefer the make it clearer approach, but will defer to whatever Peter wants.

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

Hmm.. In revision 167 Peter suggested that the serverguide link in 14.10/index.html was removed and *replaced* with a statement that there is no 14.10 version of the server guide. When I now think of it, I would have preferred a link + a statement.

Whichever route is taken on this matter, logically the clouddocs should be treated in the same way as the server guide.

Revision history for this message
Doug Smythies (dsmythies) wrote :

If "logically the clouddocs should be treated in the same way as the server guide."

Then I have a very strong opinion: Link + statement.

While I thought the "lts only" notes that I already would be good enough, I'll submit an update to this MP with clearer statements.

lp:~dsmythies/ubuntu-docs/help.ubuntu.com-infastructure updated
172. By Doug Smythies

V3 Add stable link and robots.txt rule for clouddocs

Revision history for this message
Doug Smythies (dsmythies) wrote :

O.K. here is another attempt.
Note that I have also included some of the changes Peter had in revision 167.

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

Improvments IMO.

review: Approve
Revision history for this message
Doug Smythies (dsmythies) wrote :

I was hoping Peter would chime in. I'm going to push this.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file '14.10/index.html'
2--- 14.10/index.html 2015-01-12 20:54:15 +0000
3+++ 14.10/index.html 2015-01-15 23:33:04 +0000
4@@ -53,8 +53,9 @@
5
6 <h1>Documentation for Ubuntu 14.10</h1>
7
8- <p>This site is where you can find the official documentation developed and maintained by the Ubuntu Documentation Project.</p>
9- <p>This page contains documentation for Ubuntu 14.10, the current stable support version, released in October 2014.</p>
10+ <p>This is the official documentation for Ubuntu 14.10 (released October 2014), developed and maintained by the Ubuntu Documentation Project.
11+ Please note that the Ubuntu Server Guide and Canonical Ubuntu Cloud documentation are not officially published for this non-LTS release,
12+ and their links will go to the LTS (Long Term Support) versions of the documents.</p>
13
14 <!--<h3 class="title">Desktop Documentation</h3>-->
15 <div class="itemizedlist">
16@@ -72,19 +73,27 @@
17 </li>
18 <li>
19 <p>
20+ <a href="../lts/clouddocs/en/Intro.html" target="_top">Ubuntu Cloud</a> (from Canonical; published in U.S. English only. lts only.)
21+ </p>
22+ </li>
23+ <li>
24+ <p>
25 <a href="installation-guide/index.html" target="_top">Installing Ubuntu</a> (Only published in U.S. English)
26 </p>
27 </li>
28 </ul>
29 </div>
30- <p>If you can't find what you are looking for here, visit the <a href="https://help.ubuntu.com/community/CommunityHelpWiki" target="_top">community help wiki</a>.</p>
31+ <p>If you cannot find what you are looking for here, visit the <a href="https://help.ubuntu.com/community/CommunityHelpWiki" target="_top">community help wiki</a>.</p>
32
33 <div class="clear"></div>
34 </div>
35 <div id="pagebottom"></div>
36 </div></div>
37 </div>
38-<div id="footer"><p>The material in this document is available under a free license, see <a href="/legal.html">Legal</a> for details<br> For information on contributing see the <a href="https://wiki.ubuntu.com/DocumentationTeam">Ubuntu Documentation Team wiki page</a>. To report errors in this documentation, <a href="https://bugs.launchpad.net/ubuntu/+source/ubuntu-docs">file a bug</a>.</p></div>
39+<div id="footer"><p>The material in this document is available under a free license, see <a href="/legal.html">Legal</a> for details<br>.
40+For information on contributing see the <a href="https://wiki.ubuntu.com/DocumentationTeam">Ubuntu Documentation Team wiki page</a>.
41+To report errors in this documentation, <a href="https://bugs.launchpad.net/ubuntu/+source/ubuntu-docs">file a bug</a>.
42+</p></div>
43 </div>
44 </body>
45 </html>
46
47=== modified file 'htdocs/robots.txt'
48--- htdocs/robots.txt 2014-10-29 00:22:11 +0000
49+++ htdocs/robots.txt 2015-01-15 23:33:04 +0000
50@@ -10,4 +10,5 @@
51 Disallow: /lts/ubuntu-help/
52 Disallow: /lts/installation-guide/
53 Disallow: /stable/serverguide/
54+Disallow: /stable/clouddocs/
55 Disallow: /community/*?action=
56
57=== added symlink 'stable/clouddocs'
58=== target is u'../14.04/clouddocs'
59=== modified file 'stable/index.html'
60--- stable/index.html 2014-11-10 20:09:18 +0000
61+++ stable/index.html 2015-01-15 23:33:04 +0000
62@@ -54,7 +54,9 @@
63 <h1>Documentation for Ubuntu current stable version</h1>
64
65 <p>This site is where you can find the official documentation developed and maintained by the Ubuntu Documentation Project.</p>
66- <p>This page contains documentation for the current stable support version. Please note that the Official Desktop help guide is published every cycle, whereas the Official Serverguide is only published every LTS (Long Term Support) cycle.</p>
67+ <p>This page contains documentation for the current stable support version. Please note that the Official Desktop help and Installation guides are published every release cycle,
68+ whereas the Official Serverguide and the Canonical Ubuntu Cloud documentaion are only published every LTS (Long Term Support) release cycle,
69+ and their links go to the LTS (Long Term Support) versions.</p>
70
71 <!--<h3 class="title">Desktop Documentation</h3>-->
72 <div class="itemizedlist">
73@@ -67,7 +69,13 @@
74 </li>
75 <li>
76 <p>
77- <a href="serverguide/index.html" target="_top">Ubuntu Server Guide</a> (<a href="serverguide/serverguide.pdf">PDF version</a>)
78+
79+ <a href="serverguide/index.html" target="_top">Ubuntu Server Guide</a> (lts only) (<a href="../lts/serverguide/serverguide.pdf">PDF version</a> (lts only))
80+ </p>
81+ </li>
82+ <li>
83+ <p>
84+ <a href="clouddocs/en/Intro.html" target="_top">Ubuntu Cloud</a> (from Canonical; published in U.S. English only. lts only.)
85 </p>
86 </li>
87 <li>
88@@ -77,14 +85,17 @@
89 </li>
90 </ul>
91 </div>
92- <p>If you can't find what you are looking for here, visit the <a href="https://help.ubuntu.com/community/CommunityHelpWiki" target="_top">community help wiki</a>.</p>
93+ <p>If you cannot find what you are looking for here, visit the <a href="https://help.ubuntu.com/community/CommunityHelpWiki" target="_top">community help wiki</a>.</p>
94
95 <div class="clear"></div>
96 </div>
97 <div id="pagebottom"></div>
98 </div></div>
99 </div>
100-<div id="footer"><p>The material in this document is available under a free license, see <a href="/legal.html">Legal</a> for details<br> For information on contributing see the <a href="https://wiki.ubuntu.com/DocumentationTeam">Ubuntu Documentation Team wiki page</a>. To report errors in this documentation, <a href="https://bugs.launchpad.net/ubuntu/+source/ubuntu-docs">file a bug</a>.</p></div>
101+<div id="footer"><p>The material in this document is available under a free license, see <a href="/legal.html">Legal</a> for details<br>.
102+For information on contributing see the <a href="https://wiki.ubuntu.com/DocumentationTeam">Ubuntu Documentation Team wiki page</a>.
103+To report errors in this documentation, <a href="https://bugs.launchpad.net/ubuntu/+source/ubuntu-docs">file a bug</a>.
104+</p></div>
105 </div>
106 </body>
107 </html>

Subscribers

People subscribed via source and target branches