Merge lp://staging/~matthew.revell/launchpad/inline-recipe-editor-help-721065 into lp://staging/launchpad
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 |
Related bugs: |
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.
I'm pretty sure a link saying "Read about recipe syntax" violates the
"no 'click here'" rule.