Skip to content

Conversation

rueckstiess
Copy link
Contributor

The idea is to have a separate ./src/help folder that exports a Help object. It is an Ampersand view for a new page, but it also exports a Help.open convenience method that takes an id (a string).

All help items have a unique id, for example auth-kerberos-principal. An info help button is placed somewhere in the jade templates like so

i.help.fa.fa-info-circle(data-hook='auth-kerberos-principal')

An event listener listens to all 'click i.help' events, extracts the data-hook as id, and calls Help.open(id).

Haven't figured out how to open the right window yet, and how to pass the id to the Help view.

@imlucas I'm sure this would only take you 15 minutes. Could you have a look? Could you also explain how electron window vs. page vs. router vs. app works? That's an area that's still not quite clear to me.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this shows how a help icon would be added, with the help id as a data-hook.

@imlucas imlucas assigned imlucas and rueckstiess and unassigned imlucas Nov 13, 2015
@rueckstiess rueckstiess changed the title 🚧 adding help window INT-793 help window Nov 15, 2015
@WaleyChen
Copy link
Contributor

Is this waiting for review?

@rueckstiess
Copy link
Contributor Author

Let's wait until I've merged your help window improvements in here, then probably needs a fresh rebase.

@rueckstiess
Copy link
Contributor Author

rebase was getting too crazy, had to merge master to get this in sync again.

@kangas
Copy link
Contributor

kangas commented Nov 18, 2015

  1. Merges from master->branch are 😿.
  2. Unless we untangle this, we will just merge a large hairball to master later. We've done that a few times already in haste but I want to stop repeating that pattern.
  3. The reason your rebase was getting crazy is that you're rebasing more distinct commits than make sense anymore. Squash commits to simplify commit history.
  4. Squashing commits immediately before opening the pull request would have made this easier. But that's behind us, can't change it now.
  5. We probably need to tune our rules of thumb regarding pull request etiquette to make this work in practice. Perhaps we need to write this down.
  6. Let's do a pair editing session to clean this up later today when we're both 🌞 awake.

@rueckstiess
Copy link
Contributor Author

Closing in favor of #288, which is a squashed, rebased version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants