capstone-coal / capstone-coal.github.io

COAL Project Website
https://capstone-coal.github.io/
Apache License 2.0
3 stars 1 forks source link

Website Rewrite #10

Closed ghost closed 7 years ago

ghost commented 7 years ago

This issue is to rewrite the website from scratch.

ghost commented 7 years ago

I have committed my contributions to a new root branch on my personal repository with git checkout --orphan. By design this will clobber all of the commits currently in master.

You may preview the site on my personal repo. Please review the code, the content, and the theme and suggest changes as necessary.

Note

I had to follow these instructions and change a few links to serve the preview correctly from my personal site. I have added some fake blog posts with filler text which you can ignore. You can compare the feature branch ISSUE-10-Website-Rewrite with the preview branch gh-pages to see exactly what differs between my commits and the preview.

Done

I have implemented a simple Bootstrap/Jekyll template with a shared header and footer. The home page contains a carousel with data visualizations, an overview of our project, and links to documentation, blog posts, and team info. The docs page includes information on dependencies, installation, usage, and further reading. The blog page displays excerpts from blog posts in reverse chronological order. Each blog post is formatted with a common layout. The team page describes the senior capstone project, lists team members, and provides contact information. I used the capstone-coal avatar from GitHub to create the favorites icon.

Todo

I am currently drafting blog posts that link to our fall and winter reports and presentations, sketches and other research efforts, the GDAL rotation bug fix, and our Python package. I believe this is the best way to incorporate our works in progress into the website. These could be tracked in separate issues if desired.

I still need to add a wiki page about how to edit the site and add posts. Editing the site is best accomplished by running jekyll serve locally. Posts can be drafted in the _drafts folder and published in the _posts folder. Jekyll uses special metadata sections for building the site.

The docs page will need to be updated with actual installation and usage instructions.

More

The default style is meant to be utilitarian, but it could be made prettier if desired.

We may need to ensure that the logos do not run afoul of JPL and OSU branding policies.

It would be possible to indicate the active link in the navbar with a bit of JS and/or CSS, however the site is perfectly functional without this.

I have not added a "fork me on GitHub" ribbon, but this would be super easy.

More metadata can be added to the blog posts by using Liquid variables.

One thing that I would argue against implementing is blog comment functionality. Jekyll static sites are not very well suited to comments, although I have heard of people implementing a backend server that commits these to the repo. Some use third-party comment hosting services such as Disqus, but these can have privacy implications. In my experience, moderating public comments can be an administrative nightmare. I recommend that we consider the blog to be more of a news page and solicit feedback directly via email or GitHub. However, comment functionality can of course be implemented given additional development time.

ghost commented 7 years ago

@lewismc @kwhitehall @heidiaclayton I can't open a pull request because I have implemented the changes in a new root branch. You may review my code in this branch, leave your comments here, and I can manually clobber master when the changes are approved.

ghost commented 7 years ago

The hypercube screenshot was generated in the ipython shell with commands similar to these:

import spectral
img = spectral.open_image('/media/study/OSU/winter17/cs462/data/AVNG_2015_data_distribution/L2/ang20150422t163638_rfl_v1e/ang20150422t163638_corr_v1e_img.hdr')
spectral.view_cube(img[2100:2700,115:700,290:320])

The most interesting spectral features occur between bands 290 and 320.

lewismc commented 7 years ago

Excellent, absolutely excellent. The site looks brilliant. Thank you for this.

ghost commented 7 years ago

@lewismc Pushed to live as requested.

I can either continue development pertaining to this issue in the branch ISSUE-10-Website-Rewrite and submit pull requests, or I can close this issue and file new ones to address the TODOs.

lewismc commented 7 years ago

Please close and we can file new issues in branch pull requests. Great job, honestly.