diff options
| author | Fred Lifton <fred.lifton@docker.com> | 2014-07-24 11:11:34 -0700 |
|---|---|---|
| committer | Fred Lifton <fred.lifton@docker.com> | 2014-07-24 11:11:34 -0700 |
| commit | 7dc49deedaa93ede395796108408a5459963fd92 (patch) | |
| tree | b633719915bb28a7ab762a49b34871c4a3c1c754 /docs/theme/mkdocs | |
| parent | 62173cccf71bd9c4c5654bdff0bfaf3e100d904d (diff) | |
| parent | 2969dff717e63a245c156454a4c2695c52ae5708 (diff) | |
| download | docker-docs-1.0.tar.gz | |
Merge pull request #7174 from SvenDowideit/docs-1.0-update-UX-to-add-version-selectordocs-1.0
update 1.0 Documentation UX to add the version selector, and update the ...
Diffstat (limited to 'docs/theme/mkdocs')
| -rw-r--r-- | docs/theme/mkdocs/base.html | 37 | ||||
| -rw-r--r-- | docs/theme/mkdocs/css/docs.css | 19 | ||||
| -rw-r--r-- | docs/theme/mkdocs/css/main.css | 15 | ||||
| -rw-r--r-- | docs/theme/mkdocs/footer.html | 49 | ||||
| -rw-r--r-- | docs/theme/mkdocs/header.html | 2 | ||||
| -rw-r--r-- | docs/theme/mkdocs/toc.html | 9 |
6 files changed, 94 insertions, 37 deletions
diff --git a/docs/theme/mkdocs/base.html b/docs/theme/mkdocs/base.html index d2bba34e40..2b2b9bcbcf 100644 --- a/docs/theme/mkdocs/base.html +++ b/docs/theme/mkdocs/base.html @@ -3,6 +3,13 @@ <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no"> + {% set docker_version = "$VERSION" %}{% set major_minor = "$MAJOR_MINOR" %}{% set docker_commit = "$GITCOMMIT" %}{% set docker_branch = "$GIT_BRANCH" %}{% set aws_bucket = "$AWS_S3_BUCKET" %}{% set build_date = "$BUILD_DATE" %} + <meta name="docker_version" content="{{ docker_version }}"> + <meta name="docker_git_branch" content="{{ docker_branch }}"> + <meta name="docker_git_commit" content="{{ docker_commit }}"> + <meta name="docker_build_date" content="{{ build_date }}"> + {% if meta.page_description %}<meta name="description" content="{{ meta.page_description[0] }}">{% endif %} {% if meta.page_keywords %}<meta name="keywords" content="{{ meta.page_keywords[0] }}">{% endif %} {% if site_author %}<meta name="author" content="{{ site_author }}">{% endif %} @@ -42,11 +49,23 @@ <div id="content" class="container"> {% if current_page.title != '**HIDDEN**' %} <div class="row" id="top-header"> - <div class="span8"> + <div class="span7"> <h1 class="header2">{{ current_page.title }}</h1> </div> - <div class="span4 text-right edit-on-github"> - <a class="home-link3" href="https://github.com/dotcloud/docker/blob/master/docs/sources/{{ current_page.input_path }}" class="tertiary-nav">Edit on GitHub</a> + <div class="span5"> + <div id="versionnav" class="span3 pull-right"> + <ul class="nav version pull-right"> + <li class="dropdown"> + <a id="logged-in-header-username" class="dropdown-toggle" data-toggle="dropdown" href="#"> + Latest (Version {{ major_minor }}) + </a> + <ul id="documentation-version-list" class="dropdown-menu pull-right"> + <li role="presentation" class="divider"></li> + <li> <a class="home-link3 tertiary-nav" href="https://github.com/dotcloud/docker/blob/master/docs/sources/{{ current_page.input_path }}" >Edit on GitHub</a></li> + </ul> + </li> + </ul> + </div> </div> </div> {% endif %} @@ -59,7 +78,7 @@ </div> </div> <div class="span9 content-body"> - {% include "version.html" %} + {% include "beta_warning.html" %} {{ content }} </div> </div> @@ -126,6 +145,16 @@ piCId = '1482'; }); $(document).ready(function() { $('#content').css("min-height", $(window).height() - 553 ); + // load the complete versions list + $.get("/versions.html_fragment", function( data ) { + $('#documentation-version-list').prepend(data); + //remove any "/v1.1/" bits from font. + path = document.location.pathname.replace(/^\/v\d\.\d/, ""); + $('#documentation-version-list a.version').each(function(i, e) { + e.href = e.href+path; + $(e).removeClass() + }); + }); }) var userName = getCookie('docker_sso_username'); if (userName) { diff --git a/docs/theme/mkdocs/css/docs.css b/docs/theme/mkdocs/css/docs.css index 0f42e22ef7..bd9711cb43 100644 --- a/docs/theme/mkdocs/css/docs.css +++ b/docs/theme/mkdocs/css/docs.css @@ -24,6 +24,18 @@ height: 100%; } +#leftnav h3 { + font-size: 10px; + font-weight: 700; + color: #394d54; + line-height: 1; + margin: 0px 0 10px 0; + padding-left: 20px; + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; +} + .content-body { padding: 0px 0px 0px 20px; } @@ -56,12 +68,9 @@ ol li { #nav_menu > #docsnav > #main-nav > li > a { color: #253237; } -#nav_menu > #docsnav > #main-nav > li.dd_on_hover > a { - color: #5992a3; -} #nav_menu > #docsnav > #main-nav > li.dd_on_hover { - background: #b1d5df; - color: #5992a3; + background: #d3f1fb; + color: #253237; } #nav_menu > #docsnav > #main-nav > li > span > b { border-top-color: #b1d5df !important; diff --git a/docs/theme/mkdocs/css/main.css b/docs/theme/mkdocs/css/main.css index 42a7a18a56..3375f797da 100644 --- a/docs/theme/mkdocs/css/main.css +++ b/docs/theme/mkdocs/css/main.css @@ -4,7 +4,7 @@ Core Docker style file used on - www.docker.io + www.docker.com docker-index ****************************** */ /* this is about 10% darker, but slightly different */ @@ -847,7 +847,8 @@ div + .form-inline { .navbar #usernav .nav li { padding-top: 15px; } -.navbar #usernav .nav li a { +.navbar #usernav .nav li a, +#versionnav .nav li a.dropdown-toggle { font-size: 14px; font-weight: 400; color: #394d54; @@ -856,10 +857,12 @@ div + .form-inline { padding: 0 20px 0 0; background: url("../img/nav/caret-down-user-icon.svg") no-repeat 100% 50%; } -.navbar #usernav .nav li a:hover { +.navbar #usernav .nav li a:hover, +#versionnav .nav li a.dropdown-toggle:hover { background-image: url("../img/nav/caret-down-user-icon-over.svg"); } -.navbar #usernav .nav li ul li { +.navbar #usernav .nav li ul li, +#versionnav .version { padding: 0; margin: 0; height: 28px; @@ -902,7 +905,7 @@ div + .form-inline { margin-bottom: 22px; } #leftnav .nav { - margin: 0; + margin: 0, 0, 20px, 0; } #leftnav .nav > li > a { line-height: 22px; @@ -2146,4 +2149,4 @@ a:hover { background: url("../img/homepage/docker-whale-home-logo+@2x.png"); background-size: 459px 261px; } -}
\ No newline at end of file +} diff --git a/docs/theme/mkdocs/footer.html b/docs/theme/mkdocs/footer.html index 1e2d73cf14..0b887b82d0 100644 --- a/docs/theme/mkdocs/footer.html +++ b/docs/theme/mkdocs/footer.html @@ -1,13 +1,13 @@ <div id="footer-container" class="container"> <div id="footer" class="grey-body"> <div class="row"> - <div class="span3"> + <div class="span2"> <span class="footer-title">Community</span> <ul class="unstyled"> - <li><a class="primary-button" href="http://www.docker.com/community/events/">Events</a></li> + <li><a class="primary-button" href="https://www.docker.com/community/events/">Events</a></li> <li><a class="primary-button" href="http://posts.docker.com">Friends' Posts</a></li> - <li><a class="primary-button" href="http://www.docker.com/community/meetups/">Meetups</a></li> - <li><a class="primary-button" href="http://www.docker.com/community/governance/">Governance</a></li> + <li><a class="primary-button" href="https://www.docker.com/community/meetups/">Meetups</a></li> + <li><a class="primary-button" href="https://www.docker.com/community/governance/">Governance</a></li> <li><a class="primary-button" href="http://forums.docker.com">Forums</a></li> <li><a class="primary-button" href="http://botbot.me/freenode/docker">IRC</a></li> <li><a class="primary-button" href="https://github.com/dotcloud/docker">GitHub</a></li> @@ -15,28 +15,41 @@ <li><a class="primary-button" href="http://www.cafepress.com/docker">Swag</a></li> </ul> </div> - <div class="span3"> + <div class="span2"> + <span class="footer-title">Enterprise</span> + <ul class="unstyled"> + <li><a class="primary-button" href="https://www.docker.com/enterprise/support/">Support</a></li> + <li><a class="primary-button" href="https://www.docker.com/enterprise/education/">Education</a></li> + <li><a class="primary-button" href="https://www.docker.com/enterprise/services/">Services</a></li> + </ul> + <span class="footer-title">Partner Solutions</span> + <ul class="unstyled"> + <li><a class="primary-button" href="https://www.docker.com/partners/find/">Find a Partner</a></li> + <li><a class="primary-button" href="https://www.docker.com/partners/program/">Partner Program</a></li> + <li><a class="primary-button" href="https://www.docker.com/partners/learn/">Learn More</a></li> + </ul> + </div> + <div class="span2"> <span class="footer-title">Resources</span> <ul class="unstyled"> <li><a class="primary-button" href="https://docs.docker.com">Documentation</a></li> - <li><a class="primary-button" href="http://www.docker.com/resources/help/">Help</a></li> - <li><a class="primary-button" href="http://www.docker.com/resources/education/">Education</a></li> - <li><a class="primary-button" href="http://www.docker.com/resources/partners/">Partners</a></li> - <li><a class="primary-button" href="http://www.docker.com/resources/services/">Services</a></li> - <li><a class="primary-button" href="http://www.docker.com/resources/howtobuy/">How To Buy</a></li> + <li><a class="primary-button" href="https://www.docker.com/resources/help/">Help</a></li> + <li><a class="primary-button" href="https://www.docker.com/resources/usecases/">Use Cases</a></li> + <li><a class="primary-button" href="http://www.docker.com/tryit/">Online Tutorial</a></li> + <li><a class="primary-button" href="https://www.docker.com/resources/howtobuy/">How To Buy</a></li> <li><a class="primary-button" href="http://status.docker.com">Status</a></li> - <li><a class="primary-button" href="http://www.docker.com/resources/security/">Security</a></li> + <li><a class="primary-button" href="https://www.docker.com/resources/security/">Security</a></li> </ul> </div> - <div class="span3"> + <div class="span2"> <span class="footer-title">Company</span> <ul class="unstyled"> - <li><a class="primary-button" href="http://www.docker.com/company/aboutus/">About Us</a></li> - <li><a class="primary-button" href="http://www.docker.com/company/team/">Team</a></li> - <li><a class="primary-button" href="http://www.docker.com/company/news/">News</a></li> - <li><a class="primary-button" href="http://www.docker.com/company/press/">Press</a></li> - <li><a class="primary-button" href="http://www.docker.com/company/careers/">Careers</a></li> - <li><a class="primary-button" href="http://www.docker.com/company/contact/">Contact</a></li> + <li><a class="primary-button" href="https://www.docker.com/company/aboutus/">About Us</a></li> + <li><a class="primary-button" href="https://www.docker.com/company/team/">Team</a></li> + <li><a class="primary-button" href="https://www.docker.com/company/news/">News</a></li> + <li><a class="primary-button" href="https://www.docker.com/company/press/">Press</a></li> + <li><a class="primary-button" href="https://www.docker.com/company/careers/">Careers</a></li> + <li><a class="primary-button" href="https://www.docker.com/company/contact/">Contact</a></li> </ul> </div> <div class="span3"> diff --git a/docs/theme/mkdocs/header.html b/docs/theme/mkdocs/header.html index 3560929cac..a3b1d9bd78 100644 --- a/docs/theme/mkdocs/header.html +++ b/docs/theme/mkdocs/header.html @@ -24,7 +24,7 @@ </form> <ul class="nav"> <li><a href="https://registry.hub.docker.com" title="Browse Repos">Browse Repos</a></li> - <li><a href="http://docs.docker.com" title="Documentation">Documentation</a></li> + <li class="active"><a href="http://docs.docker.com" title="Documentation">Documentation</a></li> <li><a href="http://www.docker.com/community/participate/" title="Community">Community</a></li> <li><a href="http://www.docker.com/resources/help/" title="Help">Help</a></li> </ul> diff --git a/docs/theme/mkdocs/toc.html b/docs/theme/mkdocs/toc.html index 96d15c265c..1de2a4209f 100644 --- a/docs/theme/mkdocs/toc.html +++ b/docs/theme/mkdocs/toc.html @@ -1,5 +1,8 @@ - {% for toc_item in toc %} - {% for toc_item in toc_item.children %} - <li class=""><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li> +{% for toc_item in toc %} + {% for toc_h2_item in toc_item.children %} + <li class=""><a href="{{ toc_h2_item.url }}">{{ toc_h2_item.title }}</a></li> + {% for toc_h3_item in toc_h2_item.children %} + <h3><a href="{{ toc_h3_item.url }}">{{ toc_h3_item.title }}</a></h3> + {% endfor %} {% endfor %} {% endfor %} |
