Merge lp://staging/~matthew.revell/launchpad/inline-recipe-editor-help-721065 into lp://staging/launchpad

Proposed by Matthew Revell
Status: Merged
Approved by: Данило Шеган
Approved revision: no longer in the source branch.
Merged at revision: 14337
Proposed branch: lp://staging/~matthew.revell/launchpad/inline-recipe-editor-help-721065
Merge into: lp://staging/launchpad
Diff against target: 130 lines (+7/-97)
3 files modified
lib/lp/code/browser/sourcepackagerecipe.py (+3/-6)
lib/lp/code/help/recipe-syntax.html (+0/-91)
lib/lp/code/templates/sourcepackagerecipe-index.pt (+4/-0)
To merge this branch: bzr merge lp://staging/~matthew.revell/launchpad/inline-recipe-editor-help-721065
Reviewer Review Type Date Requested Status
Francis J. Lacoste (community) Needs Resubmitting
Данило Шеган (community) Approve
Review via email: mp+66158@code.staging.launchpad.net

Commit message

[r=danilo][bug=721065] This adds a link to the recipe syntax wiki help page from the inline recipe editor page. It also changes the help link from the +edit page to go to the help wiki page, rather than a help pop-up. This removes the help pop-up, so as to avoid having to maintain the same information in two places.

Description of the change

This removes the pop-up help from the edit recipe page and replaces it with a link to the help wiki. This is to avoid having to maintain two separate versions of effectively the same document.

I favoured the help wiki version because:

 * it's available to people who aren't in the recipe UI at that time
 * it's better suited to someone who wants a reference while writing a recipe.

This branch also adds a link to that help page beneath the in-line recipe editor. We (Gavin, Huw, m'self) looked at different ways of putting this on the page but a simple text link beneath the edit widget turned out to be the best compromise between getting the help link there and not spending hours and hours on what should be a trivial text fix.

To post a comment you must log in.
Revision history for this message
Martin Pool (mbp) wrote :

I'm pretty sure a link saying "Read about recipe syntax" violates the
"no 'click here'" rule.

Revision history for this message
Matthew Revell (matthew.revell) wrote :

I'm not sure I agree but I've changed it to read "Get help with recipe syntax".

Revision history for this message
Данило Шеган (danilo) :
review: Approve
Revision history for this message
Francis J. Lacoste (flacoste) wrote :

On the add a recipe page, if you click the help link you are actually sent to another page, potentially losing all the data you entered so far. The link should open in a new window or even better in the help pop-up.

review: Needs Resubmitting

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
The diff is not available at this time. You can reload the page or download it.