Summary:

Add Help Menu

Review Request #7760 — Created Nov. 7, 2015 and discarded Dec. 18, 2020, 4:31 p.m.

Information
Owner:	kvdgulik
Repository:	Review Board
Branch:	master
Bugs:
Depends On:
Reviewers
Groups:	reviewboard
People:

Description

Created a help menu that replaces the old support menu. This new help menu allows pages to offer page specific help. The help menu also provides a key binding's reminder modal that is accessable by the '?' keyboard shortcut. This included adding the library QuestionMark.js(http://impressivewebs.github.io/QuestionMark.js/) to reviewboard, and making sure that the modal created using this library only appeared when a page has key binding content.

Testing Done

This change has been tested on Chrome, Firefox, Safari and IE.

Testing involved making sure that the links in the menu led where expected, and that the menu correctly displayed page specific content. It also invloved making sure that the key-bindings modal was accessable via the keyboard shortcut '?' in screens with keyboard shortcuts, and otherwise was not accessable.

Files

Issues

Description	From	Last Updated
Trailing whitespace.	brennie	Nov. 28, 2015, 4:09 p.m.
Should only be indented one space relative to <ul>.	brennie	Nov. 28, 2015, 4:10 p.m.
Is this the SHA of QuestionMark.js or your commit? We want to include the commit ID of QuestionMark.js that you …	brennie	Nov. 30, 2015, 3:16 p.m.
Trailing whitespace.	brennie	Dec. 4, 2015, 10:10 a.m.
Trailing whitespace.	brennie	Dec. 4, 2015, 10:10 a.m.
Undo this.	brennie	Dec. 5, 2015, 1:09 p.m.

Tool: Pyflakes
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/lib/js/question.mark.js
    reviewboard/templates/base.html
    reviewboard/templates/base/_nav_support_menu.html
    reviewboard/static/rb/css/pages/base.less
    reviewboard/static/lib/css/question.mark.css
    reviewboard/templates/reviews/reviewable_base.html



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/lib/js/question.mark.js
    reviewboard/templates/base.html
    reviewboard/templates/base/_nav_support_menu.html
    reviewboard/static/rb/css/pages/base.less
    reviewboard/static/lib/css/question.mark.css
    reviewboard/templates/reviews/reviewable_base.html

Added Files:

Status: Discarded

Status: Re-opened

Diff:

Revision 2 (+384 -2)

Show changes

	reviewboard/staticbundles.py
	reviewboard/static/lib/css/question.mark.css
	reviewboard/static/lib/js/question.mark.js
	reviewboard/static/rb/css/pages/base.less
	reviewboard/templates/base.html
	reviewboard/templates/base/_nav_support_menu.html
	reviewboard/templates/reviews/reviewable_base.html

Tool: Pyflakes
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/lib/js/question.mark.js
    reviewboard/templates/base.html
    reviewboard/templates/base/_nav_support_menu.html
    reviewboard/static/rb/css/pages/base.less
    reviewboard/static/lib/css/question.mark.css
    reviewboard/templates/reviews/reviewable_base.html



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/lib/js/question.mark.js
    reviewboard/templates/base.html
    reviewboard/templates/base/_nav_support_menu.html
    reviewboard/static/rb/css/pages/base.less
    reviewboard/static/lib/css/question.mark.css
    reviewboard/templates/reviews/reviewable_base.html

reviewboard/templates/base.html (Diff revision 2)
Show all issues
```
Trailing whitespace.
```
reviewboard/templates/base/_nav_support_menu.html (Diff revision 2)
Show all issues
```
Should only be indented one space relative to <ul>.
```

Diff:

Revision 3 (+410 -2)

Show changes

	reviewboard/staticbundles.py
	reviewboard/static/lib/css/question.mark.css
	reviewboard/static/lib/js/question.mark.js
	reviewboard/static/rb/css/pages/base.less
	reviewboard/templates/base.html
	reviewboard/templates/base/_nav_support_menu.html
	reviewboard/templates/base/helpmodal.html
	reviewboard/templates/reviews/reviewable_base.html

Tool: Pyflakes
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/lib/js/question.mark.js
    reviewboard/templates/base.html
    reviewboard/templates/base/_nav_support_menu.html
    reviewboard/static/rb/css/pages/base.less
    reviewboard/templates/base/helpmodal.html
    reviewboard/static/lib/css/question.mark.css
    reviewboard/templates/reviews/reviewable_base.html



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/lib/js/question.mark.js
    reviewboard/templates/base.html
    reviewboard/templates/base/_nav_support_menu.html
    reviewboard/static/rb/css/pages/base.less
    reviewboard/templates/base/helpmodal.html
    reviewboard/static/lib/css/question.mark.css
    reviewboard/templates/reviews/reviewable_base.html

Diff:

Revision 4 (+410 -2)

Show changes

	reviewboard/staticbundles.py
	reviewboard/static/lib/css/question.mark.css
	reviewboard/static/lib/js/question.mark.js
	reviewboard/static/rb/css/pages/base.less
	reviewboard/templates/base.html
	reviewboard/templates/base/_nav_support_menu.html
	reviewboard/templates/base/helpmodal.html
	reviewboard/templates/reviews/reviewable_base.html

Tool: PEP8 Style Checker
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/lib/js/question.mark.js
    reviewboard/templates/base.html
    reviewboard/templates/base/_nav_support_menu.html
    reviewboard/static/rb/css/pages/base.less
    reviewboard/templates/base/helpmodal.html
    reviewboard/static/lib/css/question.mark.css
    reviewboard/templates/reviews/reviewable_base.html



Tool: Pyflakes
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/lib/js/question.mark.js
    reviewboard/templates/base.html
    reviewboard/templates/base/_nav_support_menu.html
    reviewboard/static/rb/css/pages/base.less
    reviewboard/templates/base/helpmodal.html
    reviewboard/static/lib/css/question.mark.css
    reviewboard/templates/reviews/reviewable_base.html

Description:

		This task involves:

		1. COMPLETE: changing the support menu to a help menu that allows the items to change depending on what page it is accessed from.

~		2. IN PROGRESS: Enable Question Mark Js in the project and make it accessable via the 'Key Bindings' menu item
	~	2. COMPLETE: Enable Question Mark Js in the project and make it accessable via the 'Key Bindings' menu item

~		3. NOT STARTED: Modifying the question mark js modal to allow us to use it for page specific content and a variety of content other then keybindings (ex. Markdown Reminders Modal).
	~	3. COMPLETE Modifying the question mark js modal to allow us to use it for page specific content and a variety of content other then keybindings (ex. Markdown Reminders Modal).

~		4. NOT STARTED: Creating a 'Markdown Reminders' Modal accessed from the help menu
	~	4. IN PROGRESS: Creating a 'Markdown Reminders' Modal accessed from the help menu

Diff:

Revision 5 (+461 -2)

Show changes

	reviewboard/staticbundles.py
	reviewboard/static/lib/css/question.mark.css
	reviewboard/static/lib/js/README.questionmarkjs
	reviewboard/static/lib/js/question.mark.js
	reviewboard/static/rb/css/pages/base.less
	reviewboard/templates/base.html
	reviewboard/templates/base/_nav_support_menu.html
	reviewboard/templates/base/helpmodal.html
	1 more

Tool: PEP8 Style Checker
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/lib/js/question.mark.js
    reviewboard/static/lib/js/README.questionmarkjs
    reviewboard/templates/base.html
    reviewboard/templates/base/_nav_support_menu.html
    reviewboard/static/rb/css/pages/base.less
    reviewboard/templates/base/helpmodal.html
    reviewboard/static/lib/css/question.mark.css
    reviewboard/templates/reviews/reviewable_base.html



Tool: Pyflakes
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/lib/js/question.mark.js
    reviewboard/static/lib/js/README.questionmarkjs
    reviewboard/templates/base.html
    reviewboard/templates/base/_nav_support_menu.html
    reviewboard/static/rb/css/pages/base.less
    reviewboard/templates/base/helpmodal.html
    reviewboard/static/lib/css/question.mark.css
    reviewboard/templates/reviews/reviewable_base.html

Fix it!

reviewboard/static/lib/js/README.questionmarkjs (Diff revision 5)

Show all issues

Is this the SHA of QuestionMark.js or your commit? We want to include the commit ID of QuestionMark.js that you used.

kvdgulik Dec. 4, 2015, 10:05 a.m.

This is the SHA for my commit. I'm not sure what the commit for QuestionMark.js would be, as I downloaded the zip file for the project from their webpage.

reviewboard/static/lib/js/question.mark.js (Diff revision 5)
Show all issues
```
Trailing whitespace.
```
reviewboard/static/lib/js/question.mark.js (Diff revision 5)
Show all issues
```
Trailing whitespace.
```
reviewboard/static/rb/css/pages/base.less (Diff revision 5)
Show all issues
```
Undo this.
```

Diff:

Revision 6 (+461 -1)

Show changes

	reviewboard/staticbundles.py
	reviewboard/static/lib/css/question.mark.css
	reviewboard/static/lib/js/README.questionmarkjs
	reviewboard/static/lib/js/question.mark.js
	reviewboard/static/rb/css/pages/base.less
	reviewboard/templates/base.html
	reviewboard/templates/base/_nav_support_menu.html
	reviewboard/templates/base/helpmodal.html
	1 more

Tool: Pyflakes
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/lib/js/question.mark.js
    reviewboard/static/lib/js/README.questionmarkjs
    reviewboard/templates/base.html
    reviewboard/templates/base/_nav_support_menu.html
    reviewboard/static/rb/css/pages/base.less
    reviewboard/templates/base/helpmodal.html
    reviewboard/static/lib/css/question.mark.css
    reviewboard/templates/reviews/reviewable_base.html



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/lib/js/question.mark.js
    reviewboard/static/lib/js/README.questionmarkjs
    reviewboard/templates/base.html
    reviewboard/templates/base/_nav_support_menu.html
    reviewboard/static/rb/css/pages/base.less
    reviewboard/templates/base/helpmodal.html
    reviewboard/static/lib/css/question.mark.css
    reviewboard/templates/reviews/reviewable_base.html

Diff:

Revision 7 (+505 -1)

Show changes

	reviewboard/staticbundles.py
	reviewboard/static/lib/css/question.mark.css
	reviewboard/static/lib/js/README.questionmarkjs
	reviewboard/static/lib/js/question.mark.js
	reviewboard/static/rb/css/pages/base.less
	reviewboard/templates/base.html
	reviewboard/templates/base/_nav_support_menu.html
	reviewboard/templates/base/helpmodal.html
	1 more

Tool: Pyflakes
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/lib/js/question.mark.js
    reviewboard/static/lib/js/README.questionmarkjs
    reviewboard/templates/base.html
    reviewboard/templates/base/_nav_support_menu.html
    reviewboard/static/rb/css/pages/base.less
    reviewboard/templates/base/helpmodal.html
    reviewboard/static/lib/css/question.mark.css
    reviewboard/templates/reviews/reviewable_base.html



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/lib/js/question.mark.js
    reviewboard/static/lib/js/README.questionmarkjs
    reviewboard/templates/base.html
    reviewboard/templates/base/_nav_support_menu.html
    reviewboard/static/rb/css/pages/base.less
    reviewboard/templates/base/helpmodal.html
    reviewboard/static/lib/css/question.mark.css
    reviewboard/templates/reviews/reviewable_base.html

Summary:

-	WIP: Add Help Menu
+	Add Help Menu

Description:

~		This task involves:
	~	Created a help menu that replaces the old support menu. This new help menu allows pages to offer page specific help. The help menu also provides a key binding's reminder modal that is accessable by the '?' keyboard shortcut. This included adding the library QuestionMark.js(http://impressivewebs.github.io/QuestionMark.js/) to reviewboard, and making sure that the modal created using this library only appeared when a page has key binding content.
-
-		1. COMPLETE: changing the support menu to a help menu that allows the items to change depending on what page it is accessed from.
-
-		2. COMPLETE: Enable Question Mark Js in the project and make it accessable via the 'Key Bindings' menu item
-
-		3. COMPLETE Modifying the question mark js modal to allow us to use it for page specific content and a variety of content other then keybindings (ex. Markdown Reminders Modal).
-
-		4. IN PROGRESS: Creating a 'Markdown Reminders' Modal accessed from the help menu

Testing Done:

	+	This change has been tested on Chrome, Firefox, Safari and IE.
	+
	+	Testing involved making sure that the links in the menu led where expected, and that the menu correctly displayed page specific content. It also invloved making sure that the key-bindings modal was accessable via the keyboard shortcut '?' in screens with keyboard shortcuts, and otherwise was not accessable.

Diff:

Revision 8 (+512 -1)

Show changes

	reviewboard/staticbundles.py
	reviewboard/static/lib/css/question.mark.css
	reviewboard/static/lib/js/README.questionmarkjs
	reviewboard/static/lib/js/question.mark.js
	reviewboard/static/rb/css/pages/base.less
	reviewboard/templates/base.html
	reviewboard/templates/base/_nav_support_menu.html
	reviewboard/templates/base/helpmodal.html
	1 more

Tool: Pyflakes
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/lib/js/question.mark.js
    reviewboard/static/lib/js/README.questionmarkjs
    reviewboard/templates/base.html
    reviewboard/templates/base/_nav_support_menu.html
    reviewboard/static/rb/css/pages/base.less
    reviewboard/templates/base/helpmodal.html
    reviewboard/static/lib/css/question.mark.css
    reviewboard/templates/reviews/reviewable_base.html



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/staticbundles.py

Ignored Files:
    reviewboard/static/lib/js/question.mark.js
    reviewboard/static/lib/js/README.questionmarkjs
    reviewboard/templates/base.html
    reviewboard/templates/base/_nav_support_menu.html
    reviewboard/static/rb/css/pages/base.less
    reviewboard/templates/base/helpmodal.html
    reviewboard/static/lib/css/question.mark.css
    reviewboard/templates/reviews/reviewable_base.html

Add Help Menu

Added Files:

Status: Discarded

Status: Re-opened

Diff:

Diff:

Diff:

Description:

Diff:

Diff:

Diff:

Summary:

Description:

Testing Done:

Diff:

Status: Discarded