Skip to content
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

Miscellaneous website fixes #1661

Open
1 of 2 tasks
jlstevens opened this issue Jun 30, 2017 · 34 comments
Open
1 of 2 tasks

Miscellaneous website fixes #1661

jlstevens opened this issue Jun 30, 2017 · 34 comments
Assignees
Labels
type: docs Related to the documentation and examples
Milestone

Comments

@jlstevens
Copy link
Contributor

jlstevens commented Jun 30, 2017

Issue to document problems with the new website.

  • Fix heading levels e.g:

image

  • Fix broken link in About:

image

@jbednar
Copy link
Member

jbednar commented Jun 30, 2017

  • Suggestion: Move Apps to bottom of gallery page (code is advanced and not the first thing newcomers should see)

JL Edit: Manually fixed for now! Needs a long-term fix..

  • Suggestion: Move Containers to the bottom of the Reference Gallery page, as Elements can be visualized on their own, while containers can only be visualized if they contain Elements.

In general, we should make sure that the experience of someone visiting the site is to click on something that looks cool, and to see how little code was involved in making it. That's true of all our examples, but it's most true of the Elements bits -- the total code required for any of those is tiny.

The examples in the Gallery are for building more ambitious things, which take correspondingly more code, which is fine, but it's not the first thing people should be clicking on.

@jbednar
Copy link
Member

jbednar commented Jun 30, 2017

  • Suggestion: Make the black bar at the top of the theme contain only external links: GITHUB, GITTER, TWITTER -- things that launch off to other sites. The maroon bar will then contain all the internal links for navigating the web site itself.
    image

  • Suggestion: remove the footer from the theme, at most leaving the copyright bit; it's confusing to have a different, partially overlapping set of links there.
    image

@jlstevens
Copy link
Contributor Author

Not for any time soon!

  • Hovering over thumbnails in the reference gallery could result in a hover box showing a list of thumbnails (many element notebooks have multiple visualizations)

@jlstevens
Copy link
Contributor Author

Related to Jim's suggestion about moving apps to the bottom:

  • : Split gallery examples into 'Examples' and 'Advanced' so the simple examples show at the top so newcomers see the simple code first. We don't need to reflect this distinction in the /examples directory, it can be defined in the gallery building script.

@ceball
Copy link
Member

ceball commented Jun 30, 2017

Homepage

  • Broken conda link and odd "2.7 and Python 3" link.

screen shot 2017-06-30 at 6 50 11 pm

  • Minor: you recommend conda but pypi badge comes first

  • Shame that second paragraph is awkward: "For examples, check out the thumbnails below and the other items in the Gallery of demos and apps and the Reference Gallery that shows every HoloViews component." Maybe move Reference Gallery mention down, e.g. near API?

@jlstevens
Copy link
Contributor Author

jlstevens commented Jun 30, 2017

I moved the apps below demos in gallery. Can try to manually fix the issues Chris mentioned I guess...

@jlstevens
Copy link
Contributor Author

In the readme, we have:

HoloViews works with  [Python 2.7 and Python 3](https://travis-ci.org/ioam/holoviews)

So I think it was intentional and to show the Python builds we support on travis. I agree it is a bit weird though...

@ceball
Copy link
Member

ceball commented Jun 30, 2017

I was referring to the way it appears, because of which bit actually forms the link:

Python 2.7 and Python 3

instead of

Python 2.7 and Python 3

Alternatively you could consider changing it to something like

Python 2.7 and 3

@jlstevens
Copy link
Contributor Author

hmm odd, it isn't the same as the README.

@ceball
Copy link
Member

ceball commented Jun 30, 2017

FAQ

  • Many broken links, e.g.

screen shot 2017-06-30 at 7 12 46 pm

@jlstevens
Copy link
Contributor Author

#1650 lists the broken links we know about...

@jlstevens
Copy link
Contributor Author

I've opened #1662 for fixing links...

@jlstevens
Copy link
Contributor Author

I really don't get what is wrong with the definition of the conda link (homepage) in the rst...

@jlstevens
Copy link
Contributor Author

Suggestion: Move Containers to the bottom of the Reference Gallery page, as Elements can be visualized on their own, while containers can only be visualized if they contain Elements.

Agreed.

@ceball
Copy link
Member

ceball commented Jun 30, 2017

  • docs link on homepage goes back to homepage (not a broken link - more a question of is it necessary to have a docs link?)

@jbednar
Copy link
Member

jbednar commented Jun 30, 2017

I don't think it's necessary to have a docs link, and above I propose that the entire region where that link appears should be replaced with only links to external websites (which would eliminate DOCS).

@jbednar jbednar closed this as completed Jun 30, 2017
@jlstevens jlstevens reopened this Jun 30, 2017
@holoviz holoviz deleted a comment from jlstevens Jun 30, 2017
@holoviz holoviz deleted a comment from ceball Jun 30, 2017
@jbednar
Copy link
Member

jbednar commented Jun 30, 2017

Hovering over thumbnails in the reference gallery could result in a hover box showing a list of thumbnails (many element notebooks have multiple visualizations)

That could work and be useful, but I don't think it addresses the underlying problem of discoverability. The point of a gallery is to show visually the whole range of what is available, so that users can see something they are interested in, and in particular, can see some type of plot that looks something like what they imagine they need to create for their own data. For many of the notebooks in the reference gallery, there is one main plot that is a good representative of what will be found there. But for others, the thumbnail fails to convey what will be found on that page. E.g. the thumbnail for Path:

image

Does not in any way suggest to me that I'd find something like the following if I click on the page, or even that I should hover over the thumbnail:

image

For this and many other examples, I'd argue that there should be multiple thumbnails leading to this one notebook, guiding people with different mental images of what they want into something that can solve their problems. The fact that it's the same notebook repeated does not seem very important to me, just that there are multiple important different outcomes of relevance to the user that will benefit from a visual index. Same notebook, but very different plots. It's a gallery of images, not just an index of links with pictures.

The same issue applies for the regular Gallery as well, and maybe even for the User Guide and Getting-Started pages, which would be greatly aided by having a little collection of (smaller) thumbnails around each such textual description to help guide people into the section they need.

@ceball
Copy link
Member

ceball commented Jun 30, 2017

  • - "Showcase" becomes visible once you go into e.g. getting started guide, but isn't something available via the home page. A hidden showcase? Or maybe you have moved away from it?

screen shot 2017-06-30 at 11 00 11 pm

@jlstevens
Copy link
Contributor Author

Well spotted!

Or maybe you have moved away from it?

That was the plan...

@jbednar
Copy link
Member

jbednar commented Jul 1, 2017

I think Chris meant, maybe the previous page was the Showcase, somehow, which is why it shows up on this page and not the previous one. But yes, we are definitely moving away from Showcase overall...

@jlstevens
Copy link
Contributor Author

jlstevens commented Jul 1, 2017

  • The Building Composite Objects and Composing Elements have names which are too similar. Former should have been called Nesting Objects.

  • A number of getting started guides and user guides share the same name. Not necessarily a big issue but 'Live Data', 'Tabular Data' and 'Gridded Data' overlap.

@jlstevens
Copy link
Contributor Author

  • The headings 'Apps' and 'Streams' exist in the reference gallery when viewing 'Matplotlib' which does not support these types of example right now. (We could add some non-linked stream examples though...)

@jlstevens
Copy link
Contributor Author

jlstevens commented Jul 5, 2017

  • The exporting user guide didn't build properly - seems it failed to find the penguins image.

@ea42gh
Copy link
Contributor

ea42gh commented Jul 5, 2017

http://holoviews.org/user_guide/Annotating_Data.html

  • two instances of 'minimum' misspelled 'minumum'
  • fix sentence:
    " Note that we after supplying the longer labels, you still use"

@ea42gh
Copy link
Contributor

ea42gh commented Jul 5, 2017

http://holoviews.org/user_guide/Composing_Elements.html
* "These containers are unliked the dimensioned containers where you cannot mix types"
replace unliked with unlike, "associated keys." with "associatedkey."
Is it "dimensioned containers" or "dimension containers"? Both appear inthis sentence
* "As you can compose an mix of HoloViews elements" should read 'a mix'
* The paragraph starting with
"A Layout cannot contain NdLayouts but can otherwise contain" ends with
"The one restriction on what you can put in a Layout". For clarity I suggest removing the restriction in the first sentence.

@ea42gh
Copy link
Contributor

ea42gh commented Jul 5, 2017

still in Composing_Elements.html

  • "First let us see how to index the the above example" remove one instance of "the"
  • you might mention that 'print(layout)' will show the group and level names
    *'A Overlay cannot contain any other container type other than NdOverlay ' should read
    ' can contain any container type other than'?? This sentence needs fixing
    *'Overlay shared many of the same concepts as layout." replace 'shared' with'shares'
  • 'First composition with * instead of +:' just shows the resulting plot.
    Consider adding a sentence emphasizing the result.
  • 'As Overlay can be built explicitly from a list, just like a Layout :' change 'As Overlay' to 'An Overlay'
  • 'Like Layout , Overlay is fundamentally a tree-structures' replace tree-structures with tree-structure
    Next sentence has ' Overlay obejcts' rather than objects.

@ceball
Copy link
Member

ceball commented Jul 8, 2017

@philippjfr philippjfr modified the milestones: 1.8.4, v1.9 Sep 20, 2017
@jbednar jbednar mentioned this issue Sep 26, 2017
@philippjfr philippjfr modified the milestones: v1.9, v1.10 Oct 30, 2017
@philippjfr philippjfr added the type: docs Related to the documentation and examples label Mar 19, 2018
@philippjfr philippjfr modified the milestones: v1.10, v1.10.x Apr 17, 2018
@philippjfr philippjfr modified the milestones: v1.10.x, v1.11.x Nov 4, 2018
@philippjfr philippjfr modified the milestones: v1.11.x, v1.12.0 Mar 22, 2019
@philippjfr philippjfr modified the milestones: v1.12.0, v1.12.x Apr 22, 2019
@philippjfr philippjfr modified the milestones: v1.12.x, v1.13.0 Jan 5, 2020
@philippjfr philippjfr modified the milestones: v1.13.0, v1.13.x Mar 22, 2020
@philippjfr
Copy link
Member

I'd really prefer it grab bag issues like this didn't exist anymore. They're okay when gearing up for a release but after that each item should become its own issue.

@jbednar
Copy link
Member

jbednar commented Mar 23, 2020

It's a mess in its current state, but it seems like if each unticked box here is its own issue, they will get lost in the sea of other issues. Seems cleaner to me to collect remaining small website issues into a new to-do list that can be attacked by someone in one sitting...

@philippjfr
Copy link
Member

philippjfr commented Mar 23, 2020

I have many times tried to look at this issue and have given up because it's such a mess. At minimum an issue like this needs to be closed and reopened with a new, cleaned up list after each release.

@jbednar
Copy link
Member

jbednar commented Mar 23, 2020

Agreed.

@philippjfr philippjfr modified the milestones: v1.14.x, v2.0 May 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Related to the documentation and examples
Projects
None yet
Development

No branches or pull requests

5 participants