-
Notifications
You must be signed in to change notification settings - Fork 183
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.
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
Cleanup the documentation page. #247
Conversation
The Documentation page in pure html was bothering me with lots of extra element, and not really DRY, so hard to extend. This fixes all that (and also use orange as the main color... why blue we never use blue ?). I'm also tempted to remove all the /en/latest/ or /en/stable/ from the rtd links as RTD should detect the default page; not the pointing links, but that will be the subject of another PR. Also I want to change the URL from /documentation.html to /documentation/ but same; we'll do that another time.
Note that all the whitespace and |
I'd like the input of Documentation-Sensei (@willingc) as well. |
Happy to comment from an editing and outreach standpoint. Documentation-Wizard (@jzf2101) will have good insights from her recent work on JupyterLab and has a better view of @ellisonbg's vision. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've left my suggestions and edits on content. Only did a quick scan of the CSS/html commands.
IPython: https://ipython.readthedocs.io/en/stable/ | ||
IRkernel: https://irkernel.github.io/ | ||
IJulia: https://github.com/JuliaLang/IJulia.jl | ||
Community maintained kernels: https://github.com/jupyter/jupyter/wiki/Jupyter-kernels |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wondering if we should rename this last item as it implies that IRkernel and IJulia are project maintained.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's do that later. See my other PR; I can add use the data source on both page and automatically build links to Kernel documentation if needed.
_data/documentation.yml
Outdated
Community maintained kernels: https://github.com/jupyter/jupyter/wiki/Jupyter-kernels | ||
|
||
Widgets: | ||
IPyWidgets: https://ipywidgets.readthedocs.io/en/latest/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
JupyterWidgets??
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Depends if you speak of the Js library or the Python bindings !
_layouts/documentation.html
Outdated
<section> | ||
<div class="header header-grey"> | ||
<h2>Documentation</h2> | ||
<p>Browse documentation for everything in the Jupyter universe.</p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shorten perhaps:
Browse the Jupyter universe for information. or Browse the Jupyter universe.
Cool, thanks for refactoring, can you add a screenshot to make visual design review easier? |
Ok, it's been a week, merging. |
I would have liked to review this
…On Wed, Jan 17, 2018 at 8:09 AM, Matthias Bussonnier < ***@***.***> wrote:
Merged #247 <#247>.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#247 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AABr0KBtllPshCwIRfuyg064wy-m4RLwks5tLhspgaJpZM4RZiAw>
.
--
Brian E. Granger
Associate Professor of Physics and Data Science
Cal Poly State University, San Luis Obispo
@ellisonbg on Twitter and GitHub
bgranger@calpoly.edu and ellisonbg@gmail.com
|
Sorry it's been a week, and it's just a change from A-blue-we-use-nowhere to The-official-Jupyter-orange. I understand that it can be hard to not be involved in everything, but if you don't trust others the community cannot grow. It's also by doing mistakes that we learn. Also we can still revert. |
In general I am fine with a "merge and iterate" approach. At the same time, there are two reasons I think it is appropriate to have specifically asked me for review on this PR:
I think some of the challenge is that we don't have a strong sense of "team" on this repo that helps folks to know who should look at what. I have ideas how to fix that and fill follow up separately. |
When I make design decisions, I try hard to do so with a reason. Those reasons may not always be obvious; I am always willing to share my reasoning. Here were my reasons for using blue for the card headers in the documentation page:
I am totally open to other reasons that override my decision, but simply saying "we don't use blue" isn't enough to override the above reasons without discussion. |
Happy to revert to blue now that I know the reasons. It was hard for me to know that this was done on purpose seeing the number of inconsistencies in the HTML and CSS I have found; In particular it's not the first time I've refactored a page that was completly hardcoded HTML, with each html block slightly different, which was not easy. So I honestly though this was a left over from an unfinished page that did slipped through review. The links are still blue, but blue header look (to me) strongly out of style with the rest of the site. I'll send a PR reverting just the color. |
Another things that made me weight for a mistake, the |
Thanks Matthias. I am trying to put together why I used that particular
blue. Normally I would have picked a material design blue, but this isn't
one of them. Hmmmm. I am open to other blues or colors (jupyter grey?).
Very cool, that GH renders colors in line, that is one of my favorite
aspects of VS Code :-)
…On Sat, Jan 20, 2018 at 3:45 PM, Matthias Bussonnier < ***@***.***> wrote:
Oh wow ! Github renders colors now !
[image: screen shot 2018-01-20 at 15 44 47]
<https://user-images.githubusercontent.com/335567/35189110-de09fefc-fdf8-11e7-95c1-07a8bc832741.png>
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#247 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AABr0Di722Y5w9V1_WvwbYkuzaxspru2ks5tMnqBgaJpZM4RZiAw>
.
--
Brian E. Granger
Associate Professor of Physics and Data Science
Cal Poly State University, San Luis Obispo
@ellisonbg on Twitter and GitHub
bgranger@calpoly.edu and ellisonbg@gmail.com
|
The Documentation page in pure html was bothering me with lots of extra
element, and not really DRY, so hard to extend.
This fixes all that (and also use orange as the main color... why blue
we never use blue ?).
I'm also tempted to remove all the /en/latest/ or /en/stable/ from the
rtd links as RTD should detect the default page; not the pointing links,
but that will be the subject of another PR.
Also I want to change the URL from /documentation.html to
/documentation/ but same; we'll do that another time.