Website Reorganization by abostroem · Pull Request #159 · astropy/astropy.github.com · GitHub
Skip to content

Website Reorganization - #159

Merged
eteq merged 19 commits into
astropy:masterfrom
abostroem:website_update
Jun 8, 2017
Merged

eteq merged 19 commits into
astropy:masterfrom
abostroem:website_update

Conversation

@abostroem

Copy link
Copy Markdown
Contributor
  • Made About a drop down menu
    • Moved team to About menu
    • Moved "acknowledging and citation" to About menu
    • Moved "code of conduct" to About menu
    • Moved Overview from readthedocs to About in About menu
  • Moved "Report an Issue" from readthedocs to Contributing
  • Reorganized main page
  • Added more details to git help

@bsipocz

bsipocz commented May 12, 2017 •

Copy link
Copy Markdown
Member

@bsipocz

bsipocz commented May 12, 2017

Copy link
Copy Markdown
Member

Here is one of the threads: https://groups.google.com/forum/#!topic/astropy-dev/URiSCJsMCbg

@abostroem

Copy link
Copy Markdown
Contributor Author

Here are some before (left or top) and after (right or bottom) of the major changes we made.

Top Menu
screen shot 2017-05-12 at 11 32 01 am

Landing page
screen shot 2017-05-12 at 11 27 22 am

Getting Help
screen shot 2017-05-12 at 11 27 54 am

About/Overview
screen shot 2017-05-12 at 11 28 29 am

@taldcroft

Copy link
Copy Markdown
Member

Would it be possible to make this live somewhere for review?

@abostroem

Copy link
Copy Markdown
Contributor Author

I'd be happy to, but I'm not sure how...

@saimn

saimn commented May 12, 2017

Copy link
Copy Markdown
Contributor

@abostroem - In the settings of your fork, you can activate the Github Pages feature. You just have to select the master branch as Source, then your version of the website will be available at https://abostroem.github.io/astropy.github.com/

@taldcroft

Copy link
Copy Markdown
Member

If you don't get that working I can also just get your branch and view locally. But it reduces overall team effort if you can publish the new site to look at.

@abostroem

Copy link
Copy Markdown
Contributor Author

@taldcroft taldcroft left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good to me, thanks!

@mwcraig

mwcraig commented May 14, 2017 •

Copy link
Copy Markdown
Member

This looks good to me -- I like the emphasis on getting help. I think the affiliated package page could use a little attention, but I'll open a separate issue for that.

Thanks for your work on this!

@eteq eteq left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@abostroem @kelle - a few reactions from looking at the new front page:

  • I like the new drop-down for "about" - definitely makes it more readable!
  • I'm just now noticing this seems to have completely done away with the links to older versions of the documentation. Was that intended? The justification for the older versions is that a number of people do use older versions, particularly the 2-year supported LTS's, so having a straightforward way to find that is useful. Maybe the button with the drop-down that was there before can be moved to the "Learn Astropy" section? I.e., split the "Documentation" button into "Current Documentation" and the drop-down with the old ones?
  • The "the current version of astropy is 1.3.2" line seems to have been removed. I can see that this is sort of extraneous for the front page, but I wonder if it should still be somewhere? Without that, the only way for someone to know what the latest version of astropy is is to look at what the "stable" tag/ "docs.astropy.org" points to, which probably isn't obvious if the user/packager is just wondering "what's the latest version?"
  • The Please remember to acknowledge the use of Astropy! is now missing from the front page. Anecdotally, this is actually an effective way to remind people. In the new version they have to scroll all the way to the bottom and I suspect most people won't... What do you think about just putting the small text back in under the new "What is Astropy" section?
  • This is rather subjective... but one thing I like about the current version is that the two orange buttons + the little logos on the installation instructions break up the "wall of text" effect when you first land at astropy.org. The new version is a lot more text-focused. I wonder if putting back the little logos and changing the "what's new" link from a link to an orange button might fix that?

@eteq

eteq commented May 19, 2017

Copy link
Copy Markdown
Member

Oh, and I think this is meant as a companion to astropy/astropy#6051, right? (I.e., some of the info from the docs removed there is in here)

@eteq

eteq commented May 19, 2017

Copy link
Copy Markdown
Member

(FYI it looks like cb7ec8f introduced a conflict with this branch... should be pretty easy as it's just an added section, but rebasing might help, @abostroem)

@abostroem

Copy link
Copy Markdown
Contributor Author

@bsipocz I've added team back to the top menu

@eteq

  • Older documentation: I think this belongs as a link from landing page of the docs rather than the home page. It makes sense to me to put a single documentation link here. What do you think @kelle ?

  • Current version: We do have a link to What's new in astropy 1.3. This could say 1.3.2. I think this implies that this is the current version and further documentation belongs in the documentation section. What do you think @kelle ?

  • I've changed Docs to Documentation to make it more visible.

  • Please acknowledge link: to be honest I've never noticed that. I added back near its previous location

  • Orange buttons: I do like the short description and the note to cite at the top. I don't like the orange buttons (personal preferences). I've removed the about astropy section since that's in the about page and added back the 1 sentence description and note to cite. Then the first item on the page is What's new in Astropy 1.3

I'll work on rebasing next.

@abostroem

Copy link
Copy Markdown
Contributor Author

I merged in the changes to contributing. I don't think I need to rebase - let me know if I'm incorrect. Also, I updated the gh-pages website so you can preview the new version with the link above.

@abostroem

Copy link
Copy Markdown
Contributor Author

Yes, these changes should be merged at the same time as: astropy/astropy#6051 as content is being moved from between these two sites

@bsipocz

bsipocz commented May 30, 2017

Copy link
Copy Markdown
Member

@abostroem @eteq - I've made a 1.0.13 and a 1.3.3 release yesterday. Is it OK to update the links in the current pages, or this is foreseen to go in soon, so better to do the updates here?

@abostroem

Copy link
Copy Markdown
Contributor Author

@bsipocz I think these changes are close, but I'm not sure about the state of astropy/astropy#6051. @eteq @kelle . For this PR, it shouldn't be hard to merge in an updated version.

@kelle

kelle commented Jun 1, 2017

Copy link
Copy Markdown
Member

I think this looks GREAT! I agree that there could be more tweaks, but I think we should merge this PR ASAP.

  • I agree with @abostroem that there should not be links to older versions of the documentation on the home page but I also think that we could expose the links to the older documentation better. I don't think the solution is obvious. Can me make this a new issue?
  • I am not sure what I think about exposing the latest version. Maybe we want to add a links somewhere to the Change Log and release calendar? Again, I think this could be addressed in a new issue.
    @eteq , is this satisfactory resolution to your comments. This PR is more about the overall organization.
  • Regarding Major reorganization of top level doc page astropy#6051, I won't have time to address all the comments brought up there but my thinking is the same -- merge the PR and move the details into new issues to be addressed at a later date.
    This is me punting: 🏈🏃🏽‍♀️

@kelle

kelle commented Jun 8, 2017

Copy link
Copy Markdown
Member

The Sphinx doc update PR has been merged (astropy/astropy#6051.) and I resolved the conflict with index.html. I think this PR is good to go!

@granttremblay

Copy link
Copy Markdown
Member

This looks really good to me - thanks so much for your work on this!

@eteq

eteq commented Jun 8, 2017 •

Copy link
Copy Markdown
Member

@eteq
eteq merged commit a48dab5 into astropy:master Jun 8, 2017
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.

8 participants