Helper links

Discuss the technical details of Gargoyle and ongoing development

Moderator: Moderators

ispyisail
Moderator
Posts: 3668
Joined: Mon Apr 06, 2009 3:15 am
Location: New Zealand

Helper links

Postby ispyisail » Wed Oct 11, 2017 3:55 pm

re:Helper links

As you get into it you discover a few problems

Is it one link per page or many links per page?

Image


If its one link per page you would need to link to a directory page with links to other pages?

If its many links per page I would need some kind of ID system for links?

Lantis
Moderator
Posts: 3593
Joined: Mon Jan 05, 2015 5:33 am
Location: Australia

Re: Helper links

Postby Lantis » Wed Oct 11, 2017 5:44 pm

Many links per page is ok. You can use anchors to link to specific paragraphs of the wiki.
WRT1900AC V1 on 1.10.X
WNDR3800/WRT3200ACM in a constant state of flux
www.lantisproject.com for custom builds and other projects
www.lantisproject.com/gargoyle_ispyisail/ for the latest releases

d3fz
Posts: 168
Joined: Sun Aug 28, 2016 7:34 pm

Re: Helper links

Postby d3fz » Wed Oct 11, 2017 6:57 pm

It could go both ways, one/multiple links, it will depend on the complexity of the configuration or really long pages (e.g. QoS Download/Upload).

As for help links positioning, I suggest that they are placed inside panels (not at page header), right next to the respective feature/functionality that the user is having trouble with. That way, help links are only shown when needed, reducing clutter and cognitive overload.

Image
Where links redirects to:
1) http://www.gargoyle-router.com/wiki/doku.php?id=basic
2) http://www.gargoyle-router.com/wiki/doku.php?id=bridge_repeater

And for really long pages/tutorials, we could redirect straight to the wiki section, so the user doesn't need to scan through the whole tutorial searching for a specific section.
Image
Where link redirects to:
http://www.gargoyle-router.com/wiki/doku.php?id=qos#active_congestion_controller_acc
TP-Link WA850RE v1.2 - LEDE 17.01.1
TP-Link WR842ND v2 - Gargoyle 1.10.0
TP-Link Archer C7 v2 - Gargoyle 1.9.X

Tired of Chrome? Try Vivaldi - an advanced browser built for power users

ispyisail
Moderator
Posts: 3668
Joined: Mon Apr 06, 2009 3:15 am
Location: New Zealand

Re: Helper links

Postby ispyisail » Thu Oct 12, 2017 3:18 am

I had a little play making a Table before I broke the wiki :(

https://docs.google.com/spreadsheets/d/ ... sp=sharing

d3fz
Posts: 168
Joined: Sun Aug 28, 2016 7:34 pm

Re: Helper links

Postby d3fz » Thu Oct 12, 2017 3:37 pm

What do you mean you "broke the wiki" ?

Edit: Oh, I see now. Doesn't look bad, though. More like a mobile version of the wiki in "reader mode", it actually adds more focus to the content. Green links look good too. :D
TP-Link WA850RE v1.2 - LEDE 17.01.1
TP-Link WR842ND v2 - Gargoyle 1.10.0
TP-Link Archer C7 v2 - Gargoyle 1.9.X

Tired of Chrome? Try Vivaldi - an advanced browser built for power users

Lantis
Moderator
Posts: 3593
Joined: Mon Jan 05, 2015 5:33 am
Location: Australia

Re: Helper links

Postby Lantis » Sun Oct 15, 2017 3:47 pm

d3fz wrote:
Lantis wrote:That's the format i ended up using. I'll add the ability to turn these help messages off as well.

How's the progress so far ? Turning these into optional is great, i wonder if we could do the same to alert panels (or at least make them collapsible) ? This would free up some space in mobile, and gives the average user the ability to just them off, if they want to.

If we can get a list of links to help docs and where you think they should be linked from i can format the rest

ispyisail provided a helpful table to map all the necessary links, i'll use that as a reference to add other ones myself.

And last, should i open a new issue on github regarding this new feature, or is that section only oriented for bug reports ?

If you could please reply this post into the "Helper Links" thread created by ispyisail, that would be great to keep track of all posts/ideas.

Thanks.



Yes a new issue is ok. Should use that to run it by Eric before I sink too much time into it.
Your example pic is good to include
WRT1900AC V1 on 1.10.X
WNDR3800/WRT3200ACM in a constant state of flux
www.lantisproject.com for custom builds and other projects
www.lantisproject.com/gargoyle_ispyisail/ for the latest releases

ispyisail
Moderator
Posts: 3668
Joined: Mon Apr 06, 2009 3:15 am
Location: New Zealand

Re: Helper links

Postby ispyisail » Sun Oct 15, 2017 5:42 pm

Should use that to run it by Eric before I sink too much time into it.


yeah

d3fz
Posts: 168
Joined: Sun Aug 28, 2016 7:34 pm

Re: Helper links

Postby d3fz » Mon Oct 16, 2017 4:29 pm

TP-Link WA850RE v1.2 - LEDE 17.01.1
TP-Link WR842ND v2 - Gargoyle 1.10.0
TP-Link Archer C7 v2 - Gargoyle 1.9.X

Tired of Chrome? Try Vivaldi - an advanced browser built for power users


Return to “Gargoyle Development”

Who is online

Users browsing this forum: No registered users and 4 guests