Comcast / sirius

A distributed system library for managing application reference data
http://comcast.github.io/sirius/
Apache License 2.0
298 stars 49 forks source link

Sirius GitHub Pages redesign #107

Closed laurengalanter closed 10 years ago

laurengalanter commented 10 years ago

Creating new pull request to replace closed one. Image paths now fixed, was issue with how GH Pages generates paths vs local.

New front-end, largely based on designs from Austin Wells in UX (approved by Jon Moore) handed off at the beginning of the summer.

Takes full advantage of Jekyll, using header/footer/includes. Design didn't contain Overview content, so I incorporated my own design for that into the single-page structure. Refactoring of markup and styles will be done in future commits unless something egregious is found. Additional enhancements can be done in future commits (i.e. additional pages or content, search, design tweaks, etc).

You can view this live at https://laurengalanter.github.io/sirius/

tbarker9comcast commented 10 years ago

Definitely a solid improvement. A couple of comments:

alexandergurney commented 10 years ago

I like this a lot.

For me (Chrome 38.0.2125.104 on Mac OS X 10.9.5), I am seeing some interference between the "Next Steps" aside and the adjacent elements ("In short, Sirius..." and the "Maven Central" example) when the window is narrower than about 1200px. The "In short" text overlaps the "Next Steps" a bit. Then, for windows < 900px, the bullet points slide underneath the Maven Central example. I see the same in Firefox (32.0.3) and Safari (7.1). It works just fine on my phone though (Samsung S3).

Otherwise, it looks great!

comcast-jonm commented 10 years ago

I would also swap out the "Entertainment" link for a "Careers" link that points here: http://jobs.comcast.com/

But agree this looks pretty awesome!

jwakemen commented 10 years ago

The first sentence in the Operational Experiences section needs a bit of editing.

nearly two years with relatively few problems. is not accurate any longer. August 2012 was over two years ago, or the sentence should be changed to state that it had been nearly two years before the initial open source release.

I'm not sure which way to go here.

laurengalanter commented 10 years ago

Thanks for the positive feedback and comments, everyone! Some notes:

@tbarker9comcast, @comcast-jonm - Made these changes. To improve readability of links for the Technical Overview section, I've made the background darker. This way the design pattern the links use is not broken.

@alexandergurney - I made a tweak to improve this a bit, but keep in mind this site, while fluid, is not responsive.

@jwakemen - Noted, I've changed it to say "over two years with relatively few problems".

Does anyone know how I can update this PR with the additional commit that has these changes, so I don't need to make a new PR?

tbarker9comcast commented 10 years ago

To update the pr, simply push your changes to the branch you created, the likely command is: git push origin gh-pages-squash

laurengalanter commented 10 years ago

Right, I had assumed there was an extra step after pushing to get it into the PR. Cool that there's not! See new commit. Are we good to merge this iteration?

tbarker9comcast commented 10 years ago

The only problem I saw was the Read Wiki link near the top of the page points to the technical overview and not our wiki located at https://github.com/Comcast/sirius/wiki. Looks great to me. Once the link is fixed I think this is ready to merge. Thanks!

laurengalanter commented 10 years ago

D'oh! Pushing fixed link now...

tbarker9comcast commented 10 years ago

Looks great!