Autopilot

Merge lp:~nskaggs/autopilot/apdocs-restruct into lp:autopilot

apdocs-restruct
Merge into trunk

Proposed by Nicholas Skaggs on 2015-01-15

Status:	Merged
Approved by:	Leo Arias on 2015-01-22
Approved revision:	528
Merged at revision:	533
Proposed branch:	lp:~nskaggs/autopilot/apdocs-restruct
Merge into:	lp:autopilot
Diff against target:	185 lines (+86/-53) 4 files modified docs/_templates/indexcontent.html (+74/-44) docs/contents.rst (+3/-0) docs/index.rst (+9/-6) docs/tutorial/tutorial.rst (+0/-3)
To merge this branch:	bzr merge lp:~nskaggs/autopilot/apdocs-restruct
Related bugs:	Link a bug report

Reviewer	Review Type	Date Requested	Status
PS Jenkins bot	continuous-integration		Approve on 2015-01-22
Allan LeSage (community)			Approve on 2015-01-22
Christopher Lee (community)			Approve on 2015-01-21
Thomi Richards (community)			Needs Fixing on 2015-01-20
Leo Arias		2015-01-15	Needs Information on 2015-01-16
Review via email: mp+246599@code.launchpad.net

Commit Message

Initial restructuring for the autopilot docs.

Description of the Change

Initial restructuring for the autopilot docs. I pulled out specific sections to shorten the tutorial and make them more prominent on the contents page instead.

Leo Arias (elopio) wrote on 2015-01-15:

Makes sense to me. I haven't built the docs yet, I will do it after lunch.

PS Jenkins bot (ps-jenkins) wrote on 2015-01-15:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/953/rebuild

review: Needs Fixing (continuous-integration)

Leo Arias (elopio) wrote on 2015-01-16:

I like how the index looks. But shouldn't you move these files:

79 + tutorial/what_is_autopilot

81 + tutorial/good_tests
82 + tutorial/running_ap

out of the tutorial directory?

review: Needs Information

Nicholas Skaggs (nskaggs) wrote on 2015-01-16:

Leo, I suppose so. Perhaps I'll create another directory to house them.

Nicholas Skaggs (nskaggs) wrote on 2015-01-16:

Reminder for that balloons guys; add installing_autopilot section here instead of inside tutorial merge.

Christopher Lee (veebers) wrote on 2015-01-19:

I get a warning when building the docs:
..snip..docs/tutorial/advanced_autopilot.rst:427: WARNING: Inline literal start-string without end-string.

The order that the resulting menu has me pondering what the order should be.

Personally I read the column: 1st column top-to-bottom then the 2nd column top-to-bottom.

This means I see the API reference and appendice before I see mention of the tutorial.
(This way of reading it seems correct with the original layout).

If I'm an oddball though, and the only one that doesn't read it that way then this is ok. I suspect that I'm not though (i.e. reading columns, newspapers for instance, is really top to bottom then next column.) (I might still be an oddball, but not when it comes to reading columns).

review: Needs Fixing

Leo Arias (elopio) wrote on 2015-01-20:

That warning is fixed in a branch by thomi. Seems to come from before.

Nicholas Skaggs (nskaggs) wrote on 2015-01-20:

> The order that the resulting menu has me pondering what the order should be.
>
> Personally I read the column: 1st column top-to-bottom then the 2nd column
> top-to-bottom.
>

I obviously read left to right, then top to bottom. So left, right, next row and so on. I will change it to read like a newspaper. I suspect I might be alone in reading it this way.

Thomi Richards (thomir) wrote on 2015-01-20:

I agree with veebers' comments, and added one of my own. Otherwise, looks good.

review: Needs Fixing

PS Jenkins bot (ps-jenkins) wrote on 2015-01-21:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/985/rebuild

review: Approve (continuous-integration)

Christopher Lee (veebers) wrote on 2015-01-21:

LGTM

review: Approve

PS Jenkins bot (ps-jenkins) wrote on 2015-01-21:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/988/rebuild

review: Approve (continuous-integration)

PS Jenkins bot (ps-jenkins) wrote on 2015-01-22:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/990/rebuild

review: Approve (continuous-integration)

Allan LeSage (allanlesage) wrote on 2015-01-22:

Following these changes, arrived late, no objection.

review: Approve

PS Jenkins bot (ps-jenkins) wrote on 2015-01-22:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/992/rebuild

review: Approve (continuous-integration)

PS Jenkins bot (ps-jenkins) wrote on 2015-01-22:

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/autopilot-autolanding/300/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-amd64-autolanding/17/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-armhf-autolanding/17/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-i386-autolanding/17/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-vivid-autopilot/78/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-amd64/503/console

review: Needs Fixing (continuous-integration)

PS Jenkins bot (ps-jenkins) wrote on 2015-01-22:

review: Needs Fixing (continuous-integration)

PS Jenkins bot (ps-jenkins) on 2015-01-22:

review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Autopilot Hackers

Chris Gagnon

Nicholas Skaggs

 === modified file 'docs/_templates/indexcontent.html'
 --- docs/_templates/indexcontent.html	2014-05-20 22:19:53 +0000
 +++ docs/_templates/indexcontent.html	2015-01-22 16:18:29 +0000
@@ -7,54 +7,84 @@
      <tr>
        <td width="50%">
          <p class="biglink">
--          <a class="biglink" href="{{ pathto("tutorial/tutorial") }}">Autopilot Tutorial</a><br/>
--          <span class="linkdescr">Grok Autopilot!</span>
--        </p>
--      </td>
--      <td width="50%">
--        <p class="biglink">
--          <a class="biglink" href="{{ pathto("api/index") }}">API Reference</a><br/>
--          <span class="linkdescr">API reference documentation for Autopilot.</span>
--        </p>
--      </td>
--    </tr>
--    <tr>
--      <td>
--        <p class="biglink">
--          <a class="biglink" href="{{ pathto("faq/faq") }}">Frequently Asked Questions</a><br/>
--          <span class="linkdescr">...with answers!</span>
--        </p>
--      </td>
--      <td>
--        <p class="biglink">
--          <a class="biglink" href="{{ pathto("faq/troubleshooting") }}">How To Troubleshoot My Failing Test</a><br/>
--          <span class="linkdescr">My test works sometimes</span>
--          </p>
--      </td>
--    </tr>
--    <tr>
--      <td>
--        <p class="biglink">
--          <a class="biglink" href="{{ pathto("porting/porting") }}">Porting Autopilot Tests</a><br/>
--          <span class="linkdescr">How to port your tests from earlier versions of Autopilot.</span>
--        </p>
--      </td>
--      <td>
--        <p class="biglink">
--          <a class="biglink" href="{{ pathto("appendix/appendix") }}">Appendices</a><br/>
--          <span class="linkdescr">Technical documentation that doesn't fit anywhere else.</span>
--        </p>
++            <a class="biglink" href="{{ pathto("tutorial/what_is_autopilot") }}">What is Autopilot?</a><br/>
++            <span class="linkdescr">... and who is Otto anyway?</span>
++        </p>
++      </td>
++      <td width="50%">
++        <p class="biglink">
++            <a class="biglink" href="{{ pathto("faq/faq") }}">Frequently Asked Questions</a><br/>
++            <span class="linkdescr">... with answers!</span>
++        </p>
++      </td>
++    </tr>
++    <tr>
++      <td width="50%">
++        <p class="biglink">
++            <a class="biglink" href="{{ pathto("tutorial/tutorial") }}">Autopilot Tutorial</a><br/>
++            <span class="linkdescr">Grok Autopilot!</span>
++        </p>
++      </td>
++      <td width="50%">
++        <p class="biglink">
++            <a class="biglink" href="{{ pathto("porting/porting") }}">Porting Autopilot Tests</a><br/>
++            <span class="linkdescr">How to port your tests from earlier versions of Autopilot.</span>
++        </p>
++      </td>
++    </tr>
++    <tr>
++      <td width="50%">
++        <p class="biglink">
++            <a class="biglink" href="{{ pathto("guides/running_ap") }}">Running Tests</a><br/>
++            <span class="linkdescr">How do I start this thing?</span>
++          </p>
++      </td>
++     <td width="50%">
++        <p class="biglink">
++            <a class="biglink" href="{{ pathto("api/index") }}">API Reference</a><br/>
++            <span class="linkdescr">API reference documentation for Autopilot.</span>
++        </p>
++      </td>
++    </tr>
++    <tr>
++      <td width="50%">
++        <p class="biglink">
++            <a class="biglink" href="{{ pathto("guides/good_tests") }}">Writing Good Tests</a><br/>
++            <span class="linkdescr">Tips to bring out the test writer in you.</span>
++        </p>
++      </td>
++      <td width="50%">
++        <p class="biglink">
++            <a class="biglink" href="{{ pathto("appendix/appendix") }}">Appendices</a><br/>
++            <span class="linkdescr">Technical documentation that doesn't fit anywhere else.</span>
++        </p>
++      </td>
++    </tr>
++    <tr>
++      <td width="50%">
++        <p class="biglink">
++            <a class="biglink" href="{{ pathto("faq/troubleshooting") }}">How To Troubleshoot My Failing Test</a><br/>
++            <span class="linkdescr">My test works . . . sometimes  . . . </span>
++          </p>
        </td>
      </tr>
    </table>
    <h2>Indices and tables:</h2>
--  <table class="contentstable" align="center"><tr>
--    <td width="50%">
--      <p class="biglink"><a class="biglink" href="{{ pathto("py-modindex") }}">Module Index</a><br/>
--         <span class="linkdescr">quick access to all modules</span></p>
--      <p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">Complete Table of Contents</a><br/>
--         <span class="linkdescr">lists all sections and subsections</span></p>
--    </td></tr>
++  <table class="contentstable" align="center">
++      <tr>
++        <td width="50%">
++            <p class="biglink">
++                <a class="biglink" href="{{ pathto("py-modindex") }}">Module Index</a><br/>
++                <span class="linkdescr">quick access to all modules.</span>
++             </p>
++        </td>
++        <td width="50%">
++            <p class="biglink">
++                <a class="biglink" href="{{ pathto("contents") }}">Complete Table of Contents</a><br/>
++                <span class="linkdescr">lists all sections and subsections.</span>
++            </p>
++        </td>
++    </tr>
    </table>
  {% endblock %}
 === modified file 'docs/contents.rst'
 --- docs/contents.rst	2015-01-22 00:27:52 +0000
 +++ docs/contents.rst	2015-01-22 16:18:29 +0000
@@ -6,7 +6,10 @@
  .. toctree::
      :maxdepth: 5
++    tutorial/what_is_autopilot
      tutorial/tutorial
++    guides/good_tests
++    guides/running_ap
      api/index
      porting/porting
      guides/page_object
 === renamed file 'docs/tutorial/good_tests.rst' => 'docs/guides/good_tests.rst'
 === renamed file 'docs/tutorial/running_ap.rst' => 'docs/guides/running_ap.rst'
 === modified file 'docs/index.rst'
 --- docs/index.rst	2014-04-29 19:41:07 +0000
 +++ docs/index.rst	2015-01-22 16:18:29 +0000
@@ -2,9 +2,12 @@
  ##################################
  .. toctree::
--	tutorial/tutorial
--	api/index
--	faq/faq
--	porting/porting
--	appendix/appendix
--	man
++    tutorial/what_is_autopilot
++    tutorial/tutorial
++    guides/good_tests
++    guides/running_ap
++    api/index
++    faq/faq
++    porting/porting
++    appendix/appendix
++    man
 === modified file 'docs/tutorial/tutorial.rst'
 --- docs/tutorial/tutorial.rst	2013-04-16 22:51:59 +0000
 +++ docs/tutorial/tutorial.rst	2015-01-22 16:18:29 +0000
@@ -6,10 +6,7 @@
  .. toctree::
     :maxdepth: 3
--   what_is_autopilot
     getting_started
     advanced_autopilot
--   good_tests
--   running_ap