Skip to content
This repository was archived by the owner on Sep 6, 2021. It is now read-only.

Help menu changes, version 2 #7410

Merged
JeffryBooher merged 5 commits into from
Apr 5, 2014
Merged

Help menu changes, version 2 #7410

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
12e8330
Revert "Merge pull request #7392 from adobe/dangoor/revert-help"
dangoor Apr 4, 2014
3c86347
Changes the help menu to point people at the Troubleshooting wiki pag…
dangoor Apr 4, 2014
e18108b
Changes requested in review
dangoor Apr 4, 2014
03e1ae5
Merge branch 'master' into dangoor/help-menu-2
JeffryBooher Apr 4, 2014
013f328
Reword Brackets Support
JeffryBooher Apr 4, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/base-config/keyboard.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,5 +317,8 @@
],
"file.rename": [
"F2"
],
"help.support": [
"F1"
]
}
4 changes: 2 additions & 2 deletions src/brackets.config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
"about_icon" : "styles/images/brackets_icon.svg",
"update_info_url" : "http://dev.brackets.io/updates/stable/",
"how_to_use_url" : "https://github.com/adobe/brackets/wiki/How-to-Use-Brackets",
"support_url" : "http://help.brackets.io",
Copy link
Copy Markdown
Member

@peterflynn peterflynn Apr 4, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be https://github.com/adobe/brackets/wiki/Troubleshooting, no?

Copy link
Copy Markdown
Contributor Author

@dangoor dangoor Apr 4, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I think I edited the wrong config.json file. Will fix.

"get_involved_url" : "https://github.com/adobe/brackets",
"glob_help_url" : "https://github.com/adobe/brackets/wiki/Using-File-Filters",
"forum_url" : "https://groups.google.com/forum/?fromgroups#!forum/brackets-dev",
"release_notes_url" : "https://github.com/adobe/brackets/wiki/Release-Notes",
"report_issue_url" : "https://github.com/adobe/brackets/wiki/How-to-Report-an-Issue",
"twitter_url" : "https://twitter.com/brackets",
"troubleshoot_url" : "https://github.com/adobe/brackets/wiki/Troubleshooting#wiki-livedev",
"twitter_name" : "@brackets",
Expand Down
5 changes: 3 additions & 2 deletions src/command/Commands.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,10 @@ define(function (require, exports, module) {
// HELP
exports.HELP_CHECK_FOR_UPDATE = "help.checkForUpdate"; // HelpCommandHandlers.js _handleCheckForUpdates()
exports.HELP_HOW_TO_USE_BRACKETS = "help.howToUseBrackets"; // HelpCommandHandlers.js _handleLinkMenuItem()
exports.HELP_FORUM = "help.forum"; // HelpCommandHandlers.js _handleLinkMenuItem()
exports.HELP_SUPPORT = "help.support"; // HelpCommandHandlers.js _handleLinkMenuItem()
exports.HELP_SUGGEST = "help.suggest"; // HelpCommandHandlers.js _handleLinkMenuItem()
exports.HELP_RELEASE_NOTES = "help.releaseNotes"; // HelpCommandHandlers.js _handleLinkMenuItem()
exports.HELP_REPORT_AN_ISSUE = "help.reportAnIssue"; // HelpCommandHandlers.js _handleLinkMenuItem()
exports.HELP_GET_INVOLVED = "help.getInvolved"; // HelpCommandHandlers.js _handleLinkMenuItem()
exports.HELP_SHOW_EXT_FOLDER = "help.showExtensionsFolder"; // HelpCommandHandlers.js _handleShowExtensionsFolder()
exports.HELP_TWITTER = "help.twitter"; // HelpCommandHandlers.js _handleLinkMenuItem()

Expand Down
11 changes: 7 additions & 4 deletions src/command/DefaultMenus.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,14 +157,17 @@ define(function (require, exports, module) {
if (brackets.config.how_to_use_url) {
menu.addMenuItem(Commands.HELP_HOW_TO_USE_BRACKETS);
}
if (brackets.config.forum_url) {
menu.addMenuItem(Commands.HELP_FORUM);
if (brackets.config.support_url) {
menu.addMenuItem(Commands.HELP_SUPPORT);
}
if (brackets.config.suggest_feature_url) {
menu.addMenuItem(Commands.HELP_SUGGEST);
}
if (brackets.config.release_notes_url) {
menu.addMenuItem(Commands.HELP_RELEASE_NOTES);
}
if (brackets.config.report_issue_url) {
menu.addMenuItem(Commands.HELP_REPORT_AN_ISSUE);
if (brackets.config.get_involved_url) {
menu.addMenuItem(Commands.HELP_GET_INVOLVED);
}

menu.addMenuDivider();
Expand Down
5 changes: 3 additions & 2 deletions src/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@
"about_icon": "styles/images/brackets_icon.svg",
"update_info_url": "http://dev.brackets.io/updates/stable/",
"how_to_use_url": "https://github.com/adobe/brackets/wiki/How-to-Use-Brackets",
"support_url": "https://github.com/adobe/brackets/wiki/Troubleshooting",
"suggest_feature_url": "https://github.com/adobe/brackets/wiki/Suggest-a-Feature",
"get_involved_url": "https://github.com/adobe/brackets",
Copy link
Copy Markdown
Member

@peterflynn peterflynn Apr 4, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if this should point at https://github.com/adobe/brackets/blob/master/CONTRIBUTING.md instead? Seems more directly relevant

Copy link
Copy Markdown
Contributor Author

@dangoor dangoor Apr 4, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. I'll change that.

"glob_help_url": "https://github.com/adobe/brackets/wiki/Using-File-Filters",
"forum_url": "https://groups.google.com/forum/?fromgroups#!forum/brackets-dev",
"release_notes_url": "https://github.com/adobe/brackets/wiki/Release-Notes",
"report_issue_url": "https://github.com/adobe/brackets/wiki/How-to-Report-an-Issue",
"twitter_url": "https://twitter.com/brackets",
"troubleshoot_url": "https://github.com/adobe/brackets/wiki/Troubleshooting#wiki-livedev",
"twitter_name": "@brackets",
Expand Down
5 changes: 3 additions & 2 deletions src/help/HelpCommandHandlers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,10 @@ define(function (require, exports, module) {

CommandManager.register(Strings.CMD_CHECK_FOR_UPDATE, Commands.HELP_CHECK_FOR_UPDATE, _handleCheckForUpdates);
CommandManager.register(Strings.CMD_HOW_TO_USE_BRACKETS, Commands.HELP_HOW_TO_USE_BRACKETS, _handleLinkMenuItem(brackets.config.how_to_use_url));
CommandManager.register(Strings.CMD_FORUM, Commands.HELP_FORUM, _handleLinkMenuItem(brackets.config.forum_url));
CommandManager.register(Strings.CMD_SUPPORT, Commands.HELP_SUPPORT, _handleLinkMenuItem(brackets.config.support_url));
CommandManager.register(Strings.CMD_SUGGEST, Commands.HELP_SUGGEST, _handleLinkMenuItem(brackets.config.suggest_feature_url));
CommandManager.register(Strings.CMD_RELEASE_NOTES, Commands.HELP_RELEASE_NOTES, _handleLinkMenuItem(brackets.config.release_notes_url));
CommandManager.register(Strings.CMD_REPORT_AN_ISSUE, Commands.HELP_REPORT_AN_ISSUE, _handleLinkMenuItem(brackets.config.report_issue_url));
CommandManager.register(Strings.CMD_GET_INVOLVED, Commands.HELP_GET_INVOLVED, _handleLinkMenuItem(brackets.config.get_involved_url));
CommandManager.register(Strings.CMD_SHOW_EXTENSIONS_FOLDER, Commands.HELP_SHOW_EXT_FOLDER, _handleShowExtensionsFolder);
CommandManager.register(Strings.CMD_TWITTER, Commands.HELP_TWITTER, _handleLinkMenuItem(brackets.config.twitter_url));
CommandManager.register(Strings.CMD_ABOUT, Commands.HELP_ABOUT, _handleAboutDialog);
Expand Down
5 changes: 3 additions & 2 deletions src/nls/root/strings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,9 +346,10 @@ define({
"HELP_MENU" : "Help",
"CMD_CHECK_FOR_UPDATE" : "Check for Updates",
"CMD_HOW_TO_USE_BRACKETS" : "How to Use {APP_NAME}",
"CMD_FORUM" : "{APP_NAME} Forum",
"CMD_SUPPORT" : "Support for Using {APP_NAME}",
Copy link
Copy Markdown
Contributor

@JeffryBooher JeffryBooher Apr 4, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feels a little "wordy" and syntactically awkward grammar-wise. Can we just shorten it to "Troubleshooting" since the page that it links to actually is the "Troubleshooting guide".

Says so right in the title :)

Copy link
Copy Markdown
Member

@peterflynn peterflynn Apr 4, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In other distributions it might be something else -- for example, for Edge Code it would link to the support forum.

Copy link
Copy Markdown
Contributor

@JeffryBooher JeffryBooher Apr 4, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@peterflynn We can't have different strings for Edge Code and Brackets for this menu item?

Copy link
Copy Markdown
Member

@peterflynn peterflynn Apr 4, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's fair, presumably we could. I'll defer to whatever @dangoor thinks makes sense.

Copy link
Copy Markdown
Contributor Author

@dangoor dangoor Apr 4, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer Support to Troubleshooting because I think it's really more about
answering users' questions than troubleshooting. It will often be
troubleshooting, but not always. (If anything, I'd be more of the opinion
of changing the page title on GitHub, but I see no reason to do that now...
and the page title is a small thing.)

On Friday, April 4, 2014, Peter Flynn notifications@github.com wrote:

In src/nls/root/strings.js:

@@ -346,9 +346,10 @@ define({
"HELP_MENU" : "Help",
"CMD_CHECK_FOR_UPDATE" : "Check for Updates",
"CMD_HOW_TO_USE_BRACKETS" : "How to Use {APP_NAME}",

  • "CMD_FORUM" : "{APP_NAME} Forum",
  • "CMD_SUPPORT" : "Support for Using {APP_NAME}",

That's fair, presumably we could. I'll defer to whatever @dangoorhttps://github.com/dangoorthinks makes sense.

Reply to this email directly or view it on GitHubhttps://github.com//pull/7410/files#r11311331
.

"CMD_SUGGEST" : "Suggest a Feature",
"CMD_RELEASE_NOTES" : "Release Notes",
"CMD_REPORT_AN_ISSUE" : "Report an Issue",
"CMD_GET_INVOLVED" : "Hacking on Brackets",
Copy link
Copy Markdown
Contributor

@JeffryBooher JeffryBooher Apr 4, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know we're just reverting this but it seems like an opportunity to change the menu item to "Get Involved" which sounds a little more immersive and personal than "Hacking on Brackets". "Get Involved" may intrigue more folks into actually getting involved which is nice...

Copy link
Copy Markdown
Contributor Author

@dangoor dangoor Apr 4, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, we can try that. I wasn't sure initially if Get Involved would be as clear.

"CMD_SHOW_EXTENSIONS_FOLDER" : "Show Extensions Folder",
"CMD_TWITTER" : "{TWITTER_NAME} on Twitter",
"CMD_ABOUT" : "About {APP_TITLE}",
Expand Down
⚡