usg-website-templates / developer-hub Goto Github PK

Based on the following warning:
The 'pygments' configuration option has been renamed to 'highlighter'. Please update your config file accordingly. The allowed values are 'rouge', 'pygments' or null.

There are near duplicates of the stylesheets in the _static folder and the console folder. Ideally these could be consolidated into one folder and referenced from there.

I'm not sure if this will work out or not, but to minimize replacing "Agency" everywhere, we could leverage the site scope for a handful of items. Maybe leave a few more files untouched for each customization effort.

Reported by @mogul:

Reproduction steps in Gherkin-ish test code:

Scenario: The left-hand navigation should be usable without scrolling on a short page (but it is covered up by the site footer on short pages)

When I look at the developer hub microsite example,
and I click on "API calls" in the left-hand navigation,
then I should be able to see a link to the "Contribute" page in the left-hand navigation
but I cannot get to all pages listed in the left-hand navigation

Scenario: The left-hand navigation should be usable after fully scrolling on a long page, (but it is covered up by the site footer when you scroll all the way down)

When I look at the developer hub microsite example,
and I click on "Overview" in the left-hand navigation,
and I scroll to the bottom of the page
then I should be able to see a link to the "Contribute" page in the left-hand navigation
but I cannot get to all pages listed in the left-hand navigation

The console (swagger host) page currently duplicates the header, navigation and footer code. This requires any changes to be done in two places. I was able to swap out the content with includes fairly easily, but there are some questions around paths to be addressed, especially when considering use of this project as an organization site versus a project site.

Github pages has upgraded their markdown interpreter from Maruku to Kramdown, they recommend upgrading gh-page projects.

https://help.github.com/articles/migrating-your-pages-site-from-maruku

I'm not really sure if this would cause any negative impacts, but I noticed github pages is up to Ruby 2.1.1 - https://pages.github.com/versions/. Personally I get a warning about the currently specified version (1.9.3-p392) on Mac OS X, and it doesn't happily install via rvm.

The default layout file is still referring to a fully qualified URI for the css and javascript resources. I'm not sure the best way to address this and still make it easy to use as both an organization and project page in github-pages.

To make it easier for different organizations to customize this project, maybe the styles.css could be processed to allow replacement of colors and maybe some image.

This diff is a good example of changing out a key color for tailoring to a new organization.
https://github.com/GSA/sam_api/commit/5cb8faeedbc80b0c50bcc6fd4ea54081509b2c22#diff-a16a51aaea7dc21d3202074fc7228024

Something along these lines:

---
accentColor1: "#09c"

---
.header {
    border-bottom: 4px solid {{ page.accentColor1 }};
    width: 100%;
    background-color: #fff;
    /*position: fixed;*/
    top: 0;
    z-index: 99999;
}