Skip to content

PR: Eliminate redundant links from sidebar, add standard links to readme and fix minor layout bugs #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jul 16, 2018
Merged

PR: Eliminate redundant links from sidebar, add standard links to readme and fix minor layout bugs #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
efdd82a
Add FB and Twitter links to Readme
CAM-Gerlach May 7, 2018
8d31906
Add additional links to sidebar and remove redundant main website
CAM-Gerlach May 7, 2018
5f20b73
Fix very minor issue with ToC link display
CAM-Gerlach May 7, 2018
adce80d
Add doc link to readme
CAM-Gerlach May 7, 2018
1d35f70
Add bottom margin to numeric lists
CAM-Gerlach May 11, 2018
bf7cef7
Update Google Groups readme and sidebar links to https
CAM-Gerlach May 13, 2018
df8e554
Move social media links from sidebar to footer, and fix margins
CAM-Gerlach May 13, 2018
603863a
Cleanup extra white space in layout.html
CAM-Gerlach May 13, 2018
748678b
Remove extra footer that will be replace by new common one
CAM-Gerlach May 28, 2018
d04ef40
Cut relations and a few more links & update wiki link to follow #62
CAM-Gerlach Jul 8, 2018
f03f7dc
Eliminate conflicting footer block in custom.css
CAM-Gerlach Jul 8, 2018
249d73c
Merge 3.x to resolve silly custom.css conflict and update look
CAM-Gerlach Jul 8, 2018
2135c2c
Streamline list margin fixes into one line and make height adaptive
CAM-Gerlach Jul 8, 2018
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
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ your support of the project!

[Download Spyder (with Anaconda)](https://www.anaconda.com/download/)

[Online Documentation](http://docs.spyder-ide.org/)

[Spyder Github](https://github.com/spyder-ide/spyder)

[Troubleshooting Guide and FAQ](
Expand All @@ -69,6 +71,10 @@ https://github.com/spyder-ide/spyder/wiki/Troubleshooting-Guide-and-FAQ)

[Gitter Chatroom](https://gitter.im/spyder-ide/public)

[Google Group](http://groups.google.com/group/spyderlib)
[Google Group](https://groups.google.com/group/spyderlib)

[@Spyder_IDE on Twitter](https://twitter.com/spyder_ide)

[@SpyderIDE on Facebook](https://www.facebook.com/SpyderIDE/)

[Support Spyder on OpenCollective](https://opencollective.com/spyder/)
4 changes: 2 additions & 2 deletions doc/_static/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ div .line-block {
margin-bottom: 0px;
}

ul.simple {
margin-bottom: 24px;
ul.simple, div .toctree-wrapper, ol.arabic {
margin-bottom: 1.57em;
}

div.body p, div.body dd, div.body li {
Expand Down
8 changes: 4 additions & 4 deletions doc/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@
<div class="js-sticky">
<div class="fh5co-main-nav navbar fixed-top">
<div class="container">
<div class="fh5co-menu-1">
<div class="fh5co-menu-1">
<div class="pull-left">
<ul class="dropdown menu" data-dropdown-menu>
<li id="menu-logo">
<p></p>
<a href="./index.html">
<img src="https://www.spyder-ide.org/static/images/spyder-logo.svg">
<span>
<span id="logo-text"><big>S</big>pyder | Docs</span>
<span id="logo-text"><big>S</big>pyder | Docs</span>
</span>
</a>
<p></p>
Expand All @@ -42,12 +42,12 @@
<a class="pull-right" href="https://www.spyder-ide.org">Home</a>
</div>
</div>
</div>
</div>
</div>
<div id="doc-content" data-section="Docs">
{{super()}}
</div>
</div>
</div>
</div>
{% endblock %}
{% block footer %}
Expand Down
10 changes: 2 additions & 8 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,15 +126,9 @@
'travis_button': False,
'codecov_button': False,
'extra_nav_links': {
Copy link
Member

Choose a reason for hiding this comment

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

Let's remove all these extra links in this PR. We'll put them all in the footer.

Copy link
Member Author

@CAM-Gerlach CAM-Gerlach May 29, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

TL;DR: Due to the number of links in the footer, to maintain conceptual cohesion with what links we put where, and to ensure important links are more visible and easily accessible, we shouldn't put everything in the footer. Specifically

  • Troubleshooting Guide and Dev Wiki need to stay in the sidebar due to their strong link to the content and other sidebar items
  • Download (link to main page section) and Donate (direct link to OC) should go in the common top banner across all sites since those are the two actions we want people to take to help Spyder grow and thrive
  • Github is a marginal case, but it can go in the footer I guess

Finally, all being important and already present, they should naturally be removed in the PR that actually adds them to the header/footer; no compelling reason to do so here.

More detailed rationale and discussion:

I'm not sure I agree. Conceptually, the main problem with putting everything in the footer, aside from the simple number of links we're stuffing in to a small space, is that footers are useful for links people specifically know and have motivation to look for, and very likely will only want until after reading at least the content on the existing page—things like the "connect with us"/social media type links I've put there, as well as legal and policy information that need to be there but we don't want to emphasize or take up too much space in the UI. If it isn't something people both know and want to look for, and is something we have at least a modest interest in actually wanting people to visit; or, otherwise is conceptually much closer to the content than the type of items in the footer, we should put it in the sidebar so people actually see it, and right away. Reviewing those characteristics for each of the links there:

The Troubleshooting Guide and the Dev Wiki definitely belong in the sidebar, not the footer, because unlike the others they are not "Connect with Spyder" resources they are directly documentation-related resources that just happen to not be hosted in the same place, and thus have a strong conceptual link with the content (basically being an extension of the items listed in the sidebar); additionally, people would not be aware of them by default and know to scroll all the way down to search for them in the footer, we strongly want people who need them to visit them, and they should be quickly accessible for interested parties.

For the Download and Donate links, these should go in the common top bar/banner for both the blog and the docs, just like we currently have them for the main page. These are the two key links we really want to make as obvious and accessible as possible, as these are the two key actions we want people to take to help them get the benefits of Spyder (and us get more users), and help make Spyder better for them and everyone. The Donate link should go direct to OpenCollective (as it really should on our main page; having it scroll to a simple button provides no additional value while increasing user time/annoyance and decreasing final conversion rate). The Download I guess should go to the download section on our main site, as it does there, since the interstitial provides significant value and we don't control the final destination page like we do for OC. Therefore, these should be left here, and removed in the PR that adds them to the banner (presuming that is desired).

The Spyder Github link is sort of a gray area; it involves both communication/interaction, is a source for information (via the readme, contrib guide etc and examining the code itself), and is also a secondary major platform we want to direct people to (for bug reports, feature requests, source downloads and most importantly to help with development). Probably not enough so to give it top billing in the sticky banner, but we still want it common across the sites. Although I'd like it to have more emphasis, I wouldn't be opposed to sticking it that one the footer, since I don't have a better idea right now.

Finally, since none of those links were added in this PR, and all are quite important, it is out of scope to remove them here, and that should rather naturally be done in the PR(s) that actually add them to the footer or top bar banner. There's no compelling reason to do so prematurely, when it would be better done, conceptually and practically, in the PR that actually adds them.

On a minor note, we might also want to put Stack Overflow in the footer since that's an important resource for a lot of user questions and is chiefly focused on interaction like the others; it isn't anywhere right now.

'Main Website': 'https://www.spyder-ide.org/',
'Download (Anaconda)': 'https://www.anaconda.com/download/',
'Spyder Github': 'https://github.com/spyder-ide/spyder',
'Troubleshooting': ('https://github.com/spyder-ide/spyder/wiki/'
+ 'Troubleshooting-Guide-and-FAQ'),
'Dev Wiki': 'https://github.com/spyder-ide/spyder/wiki/Dev:-Index',
'Gitter Chatroom': 'https://gitter.im/spyder-ide/public',
'Google Group': 'http://groups.google.com/group/spyderlib',
'Donate': 'https://opencollective.com/spyder/'
'Spyder Wiki': 'https://github.com/spyder-ide/spyder/wiki',
},
'sidebar_collapse': True,
'show_related': True,
Expand Down Expand Up @@ -195,7 +189,7 @@
'**': [
'about.html',
'navigation.html',
'relations.html',
#'relations.html',
'searchbox.html',
'donate.html',
]
Expand Down