Skip to content

Docs: Update for latest Hugo and fix whitespace #402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 24, 2017
Merged

Docs: Update for latest Hugo and fix whitespace #402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/landing/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The static front page site for the Java documentation portal.

## Requirements
Hugo version 0.13 [download here](https://github.com/spf13/hugo/releases/tag/v0.13)
Hugo version 0.21 [download here](https://github.com/spf13/hugo/releases/tag/v0.21)
Copy link
Member Author

Choose a reason for hiding this comment

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

Updated to the latest Hugo version 0.21

<br>
Check out the hugo [quickstart guide](http://gohugo.io/overview/quickstart/).

Expand Down
2 changes: 2 additions & 0 deletions docs/landing/config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,7 @@ baseurl = "/mongo-java-driver/"
languageCode = "en-us"
title = "MongoDB Java Driver"
canonifyurls = false
disableHugoGeneratorInject = true
disableKinds = ["section", "taxonomy", "taxonomyTerm", "404"]
Copy link
Member Author

Choose a reason for hiding this comment

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

Hugo 0.18 broke directory/index.md. So turning off section and taxonomy type pages fixed the issue. I also disabled the 404 page as it isn't used. Only the top level 404 page is used and there isnt a mongodb/mongodb repo with gh-pages so there isnt a custom 404 page.


githubRepo = "mongo-java-driver"
2 changes: 1 addition & 1 deletion docs/landing/layouts/404.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
{{ partial "meta.html"}}
<link rel="shortcut icon" href="{{.Site.BaseUrl}}/img/favicon.png">
<link rel="shortcut icon" href="{{.Site.BaseURL}}/img/favicon.png">
Copy link
Member Author

Choose a reason for hiding this comment

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

The other braking changes was Url => URL


<title>{{.Title}}</title>

Expand Down
26 changes: 13 additions & 13 deletions docs/landing/layouts/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
<!DOCTYPE html>
<html lang="en">
<head>
{{ partial "meta.html"}}
<link rel="shortcut icon" href="{{.Site.BaseUrl}}/s/img/favicon.png">
{{- partial "meta.html" -}}
Copy link
Member Author

Choose a reason for hiding this comment

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

Go added whitespace trimming into its template language and now the reference index page size has been reduced from over 3000 lines to 350.

<link rel="shortcut icon" href="{{.Site.BaseURL}}/s/img/favicon.png">

<title>{{.Title}}</title>

{{ partial "assets/css.html" . }}
{{- partial "assets/css.html" . -}}
</head>

<body>
<!--header start-->
{{ partial "header/main.html" . }}
{{- partial "header/main.html" . -}}
<!--header end-->

{{ partial "hero.html" . }}
{{- partial "hero.html" . -}}

<!-- Main content -->
<div class="container" id="mainContent">
<div class="row">
<div class="col-md-8">
{{ partial "introduction.html" . }}
{{- partial "introduction.html" . -}}

{{ partial "features.html" . }}
{{- partial "features.html" . -}}

{{ partial "quickStart.html" . }}
{{- partial "quickStart.html" . -}}
</div>
<div class="col-md-4">
{{ partial "releases.html" . }}
{{ partial "mongodbUniversity.html" . }}
{{- partial "releases.html" . -}}
{{- partial "mongodbUniversity.html" . -}}
</div>
</div>
</div>
Expand All @@ -38,15 +38,15 @@
<div class="container">
<div class="row">
<div class="col-md-12">
{{ partial "footer.html" .}}
{{- partial "footer.html" . -}}
</div>
</div>
</div>
<!-- End footer -->


<!-- javascripts -->
{{ partial "assets/javascripts.html" . }}
{{ partial "assets/analytics.html" . }}
{{- partial "assets/javascripts.html" . -}}
{{- partial "assets/analytics.html" . -}}
</body>
</html>
12 changes: 6 additions & 6 deletions docs/landing/layouts/partials/assets/css.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<link rel="stylesheet" href="{{.Site.BaseUrl}}/s/lib/bootstrap.min.css" type="text/css" />
<link rel="stylesheet" href="{{.Site.BaseUrl}}/s/lib/font-awesome/css/font-awesome.min.css" type="text/css" />
<link rel="stylesheet" href="{{.Site.BaseUrl}}/s/lib/highlight/styles/vs.css" type="text/css" />
<link rel="stylesheet" href="{{.Site.BaseUrl}}/s/lib/bootstrap-select/bootstrap-select.min.css" type="text/css" />
<link rel="stylesheet" href="{{.Site.BaseUrl}}/s/lib/bootstrap-toggle/bootstrap-toggle.min.css" type="text/css" />
<link rel="stylesheet" href="{{.Site.BaseUrl}}/s/css/frontpage.css" type="text/css" />
<link rel="stylesheet" href="{{.Site.BaseURL}}/s/lib/bootstrap.min.css" type="text/css" />
<link rel="stylesheet" href="{{.Site.BaseURL}}/s/lib/font-awesome/css/font-awesome.min.css" type="text/css" />
<link rel="stylesheet" href="{{.Site.BaseURL}}/s/lib/highlight/styles/vs.css" type="text/css" />
<link rel="stylesheet" href="{{.Site.BaseURL}}/s/lib/bootstrap-select/bootstrap-select.min.css" type="text/css" />
<link rel="stylesheet" href="{{.Site.BaseURL}}/s/lib/bootstrap-toggle/bootstrap-toggle.min.css" type="text/css" />
<link rel="stylesheet" href="{{.Site.BaseURL}}/s/css/frontpage.css" type="text/css" />
14 changes: 7 additions & 7 deletions docs/landing/layouts/partials/assets/javascripts.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<script type="text/javascript" src="{{.Site.BaseUrl}}/s/js/jquery.js"></script>
<script type="text/javascript" src="{{.Site.BaseUrl}}/s/lib/bootstrap.js"></script>
<script type="text/javascript" src="{{.Site.BaseUrl}}/s/lib/highlight/highlight.pack.js"></script>
<script type="text/javascript" src="{{.Site.BaseUrl}}/s/lib/bootstrap-select/bootstrap-select.min.js"></script>
<script type="text/javascript" src="{{.Site.BaseUrl}}/s/lib/bootstrap-toggle/bootstrap-toggle.min.js"></script>
<script type="text/javascript" src="{{.Site.BaseUrl}}/s/lib/zeroclipboard/ZeroClipboard.min.js"></script>
<script type="text/javascript" src="{{.Site.BaseUrl}}/s/js/frontpage.js"></script>
<script type="text/javascript" src="{{.Site.BaseURL}}/s/js/jquery.js"></script>
<script type="text/javascript" src="{{.Site.BaseURL}}/s/lib/bootstrap.js"></script>
<script type="text/javascript" src="{{.Site.BaseURL}}/s/lib/highlight/highlight.pack.js"></script>
<script type="text/javascript" src="{{.Site.BaseURL}}/s/lib/bootstrap-select/bootstrap-select.min.js"></script>
<script type="text/javascript" src="{{.Site.BaseURL}}/s/lib/bootstrap-toggle/bootstrap-toggle.min.js"></script>
<script type="text/javascript" src="{{.Site.BaseURL}}/s/lib/zeroclipboard/ZeroClipboard.min.js"></script>
<script type="text/javascript" src="{{.Site.BaseURL}}/s/js/frontpage.js"></script>
2 changes: 1 addition & 1 deletion docs/landing/layouts/partials/footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div class="footer">
<div class="copyright">
<p>Copyright © 2008-2016 <a class="smalltext" href="http://www.mongodb.com">MongoDB, Inc</a>.
<p>Copyright © 2008-2017 <a class="smalltext" href="http://www.mongodb.com">MongoDB, Inc</a>.
MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.
</p>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/landing/layouts/partials/header/main.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
<div class="header-content">
<!--logo start-->
<div class="logo pull-left">
<a href="{{.Site.BaseUrl}}">
<img src="{{.Site.BaseUrl}}/s/img/logo-mongodb-header.png", alt="MongoDB.org" />
<a href="{{.Site.BaseURL}}">
<img src="{{.Site.BaseURL}}/s/img/logo-mongodb-header.png", alt="MongoDB.org" />
</a>
</div>
<!--logo end-->
Expand Down
6 changes: 4 additions & 2 deletions docs/landing/layouts/partials/hero.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ <h2>MongoDB Java Driver</h2>
The next generation Java driver for MongoDB
</p>
<p>
{{ range where $.Site.Data.releases.versions "version" $.Site.Data.releases.current }}{{ $.Scratch.Set "qs.currentReleasedVersion" . }}{{end }}
{{$currentReleasedVersion := $.Scratch.Get "qs.currentReleasedVersion"}}
{{- range where $.Site.Data.releases.versions "version" $.Site.Data.releases.current -}}
{{- $.Scratch.Set "qs.currentReleasedVersion" . -}}
{{- end -}}
{{- $currentReleasedVersion := $.Scratch.Get "qs.currentReleasedVersion" -}}
<a href="{{$currentReleasedVersion.docs}}" class="btn btn-success btn-dark btn-mongo">Latest documentation</a>
</p>

Expand Down
102 changes: 53 additions & 49 deletions docs/landing/layouts/partials/quickStart.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,37 +8,41 @@ <h2 id="quickStart">Quick Start</h2>
Alternatively, head over to our documentation to learn more about getting started with Java and MongoDB.
</p>

{{ range where $.Site.Data.releases.versions "version" $.Site.Data.releases.current }}{{ $.Scratch.Set "qs.currentReleasedVersion" . }}{{end }}
{{$currentReleasedVersion := $.Scratch.Get "qs.currentReleasedVersion"}}
{{- range where $.Site.Data.releases.versions "version" $.Site.Data.releases.current -}}
{{- $.Scratch.Set "qs.currentReleasedVersion" . -}}
{{- end -}}
{{- $currentReleasedVersion := $.Scratch.Get "qs.currentReleasedVersion" -}}

<div id="downloadWidget">
<div class="container">
<div class="row downloadForm">
<form>
<div class="col-xs-5 col-lg-4 col-lg-push-2 ">
{{ $.Scratch.Set "qs.pos" 0 }}
{{ $.Scratch.Set "qs.firstDriver" false }}
{{ with $.Site.Data.releases.drivers }}
{{- $.Scratch.Set "qs.pos" 0 -}}
{{- $.Scratch.Set "qs.firstDriver" false -}}
{{- with $.Site.Data.releases.drivers -}}
<select class="driverPicker">
{{ range . }}
{{ if eq ($.Scratch.Get "qs.firstDriver") false }}{{ $.Scratch.Set "qs.firstDriver" . }}{{end}}
<option value="{{$.Scratch.Get "qs.pos"}}" data-versions="{{.versions}}">{{.name}}</option>
{{ $.Scratch.Add "qs.pos" 1 }}
{{ end }}
{{- range . -}}
{{- if eq ($.Scratch.Get "qs.firstDriver") false -}}
{{- $.Scratch.Set "qs.firstDriver" . -}}
{{- end -}}
<option value="{{$.Scratch.Get "qs.pos"}}" data-versions="{{.versions}}">{{.name}}</option>
{{- $.Scratch.Add "qs.pos" 1 -}}
{{- end -}}
</select>
{{ end }}
{{- end -}}
</div>
<div class="col-xs-5 col-lg-4 col-lg-push-2 ">
{{ $.Scratch.Set "qs.pos" 0 }}
{{ $firstDriver := $.Scratch.Get "qs.firstDriver"}}
{{ with $.Site.Data.releases.versions }}
{{- $.Scratch.Set "qs.pos" 0 -}}
{{- $firstDriver := $.Scratch.Get "qs.firstDriver" -}}
{{- with $.Site.Data.releases.versions -}}
<select class="releasePicker">
{{ range . }}
<option value="{{$.Scratch.Get "qs.pos"}}" {{ if eq (in $firstDriver.versions .version) false }}disabled="disabled"{{else if eq .status "current"}}selected{{end}}>{{.version}}</option>
{{ $.Scratch.Add "qs.pos" 1 }}
{{ end }}
{{- range . -}}
<option value="{{$.Scratch.Get "qs.pos"}}" {{ if eq (in $firstDriver.versions .version) false }}disabled="disabled"{{else if eq .status "current"}}selected{{end}}>{{.version}}</option>
{{- $.Scratch.Add "qs.pos" 1 -}}
{{- end -}}
</select>
{{ end }}
{{- end -}}
</div>
<div class="col-lg-2 col-lg-push-2 ">
<input type="checkbox" checked class="distroPicker" data-toggle="toggle" data-on="Maven" data-off="Gradle" data-offstyle="success">
Expand All @@ -55,21 +59,21 @@ <h2 id="quickStart">Quick Start</h2>
<div class="clipboard" title="copy">
<button class="btn btn-dark"><i class="fa fa-clipboard fa-2"></i></button>
</div>
{{ $currentNode := . }}
{{ $.Scratch.Set "qs.firstDriver" true }}
{{ with $currentNode.Site.Data.releases.drivers }}
{{ $.Scratch.Set "qs.driverPos" 0 }}
{{ range . }}
{{ $currentDriver := . }}
{{ with $.Site.Data.releases.versions }}
{{ $.Scratch.Set "qs.versionPos" 0 }}
{{ range . }}
{{ $currentVersion := . }}
{{ $firstDriver := $.Scratch.Get "qs.firstDriver"}}
{{ $driverPos := $.Scratch.Get "qs.driverPos" }}
{{ $versionPos := $.Scratch.Get "qs.versionPos" }}
{{ if in $currentDriver.versions $currentVersion.version }}
{{ if in $currentVersion.version "SNAPSHOT" }}
{{- $currentNode := . -}}
{{- $.Scratch.Set "qs.firstDriver" true -}}
{{- with $currentNode.Site.Data.releases.drivers -}}
{{- $.Scratch.Set "qs.driverPos" 0 -}}
{{- range . -}}
{{- $currentDriver := . -}}
{{- with $.Site.Data.releases.versions -}}
{{- $.Scratch.Set "qs.versionPos" 0 -}}
{{- range . -}}
{{- $currentVersion := . -}}
{{- $firstDriver := $.Scratch.Get "qs.firstDriver" -}}
{{- $driverPos := $.Scratch.Get "qs.driverPos" -}}
{{- $versionPos := $.Scratch.Get "qs.versionPos" -}}
{{- if in $currentDriver.versions $currentVersion.version -}}
{{- if in $currentVersion.version "SNAPSHOT" -}}
<div id="maven-{{$versionPos}}-{{$driverPos}}" class="download {{if or (ne $firstDriver true) (ne $currentVersion.status "current") }} hidden{{end}}">
<pre><code>
&lt;dependencies&gt;
Expand Down Expand Up @@ -104,8 +108,8 @@ <h2 id="quickStart">Quick Start</h2>
}
</code></pre>
</div>
{{ else }}
<div id="maven-{{$versionPos}}-{{$driverPos}}" class="download {{if or (ne $firstDriver true) (ne $currentVersion.status "current") }} hidden{{end}}">
{{- else -}}
<div id="maven-{{$versionPos}}-{{$driverPos}}" class="download {{ if or (ne $firstDriver true) (ne $currentVersion.status "current") }} hidden{{end}}">
<pre><code>
&lt;dependencies&gt;
&lt;dependency&gt;
Expand All @@ -126,21 +130,21 @@ <h2 id="quickStart">Quick Start</h2>

</code></pre>
</div>
{{ end }}
{{ if eq $currentVersion.status "current" }}
{{ $.Scratch.Set "qs.firstDriver" false }}
{{end}}
{{ $.Scratch.Add "qs.versionPos" 1 }}
{{ end }}
{{ end }}
{{ end }}
{{ $driverPos := $.Scratch.Get "qs.driverPos" }}
{{- end -}}
{{- if eq $currentVersion.status "current" -}}
{{- $.Scratch.Set "qs.firstDriver" false -}}
{{- end -}}
{{- $.Scratch.Add "qs.versionPos" 1 -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{- $driverPos := $.Scratch.Get "qs.driverPos" -}}
<div id="driver-{{$driverPos}}" class="download description{{if ne $driverPos 0}} hidden{{end}}">
{{$currentDriver.description | markdownify}}
{{- $currentDriver.description | markdownify -}}
</div>
{{ $.Scratch.Add "qs.driverPos" 1 }}
{{ end }}
{{ end }}
{{- $.Scratch.Add "qs.driverPos" 1 -}}
{{- end -}}
{{- end -}}
</div>
</div>
</div>
8 changes: 4 additions & 4 deletions docs/landing/layouts/partials/releases.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
{{ with $.Site.Data.releases.versions }}
{{- with $.Site.Data.releases.versions -}}
<section id="releases">
<h2>Releases</h2>
<table class="table table-striped">
<thead><tr><th>Release</th><th>Documentation</th></tr></thead>
<tbody>
{{ range . }}
{{- range . -}}
<tr>
<th class="{{.status}}">{{.version}}</th>
<td><a href="{{.docs}}" class="reference">Reference</a> &#124; <a href="{{.api}}">API</a></td>
</tr>
{{ end }}
{{- end -}}
</tbody>
</table>
</section>
{{ end }}
{{- end -}}
2 changes: 1 addition & 1 deletion docs/reference/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
3. Create content

## Requirements
Hugo version 0.13 [download here](https://github.com/spf13/hugo/releases/tag/v0.13)
Hugo version 0.21 [download here](https://github.com/spf13/hugo/releases/tag/v0.21)
<br>
Check out the hugo [quickstart guide](http://gohugo.io/overview/quickstart/).

Expand Down
7 changes: 4 additions & 3 deletions docs/reference/config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
baseurl = "/mongo-java-driver/3.4"
baseURL = "/mongo-java-driver/3.4"
languageCode = "en-us"
title = "MongoDB Java Driver"
theme = "mongodb"
canonifyurls = false
canonifyURLs = false
disableHugoGeneratorInject = true
disableKinds = ["section", "taxonomy", "taxonomyTerm", "404"]

[blackfriday]
plainIdAnchors = true


# Update versions in mongodb.toml as well
[[menu.main]]
name = "API Documentation"
Expand Down
1 change: 1 addition & 0 deletions docs/reference/content/driver-async/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
+++
date = "2015-03-17T15:36:56Z"
title = "MongoDB Async Driver"
type = "index"
[menu.main]
weight = 30
identifier = "MongoDB Async Driver"
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/layouts/partials/assets/cssExtras.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<link rel="stylesheet" href="{{.Site.BaseUrl}}/lib/bootstrap-toggle/bootstrap-toggle.min.css" type="text/css" />
<link rel="stylesheet" href="{{.Site.BaseUrl}}/css/java.css" type="text/css" />
<link rel="stylesheet" href="{{.Site.BaseURL}}/lib/bootstrap-toggle/bootstrap-toggle.min.css" type="text/css" />
<link rel="stylesheet" href="{{.Site.BaseURL}}/css/java.css" type="text/css" />
4 changes: 2 additions & 2 deletions docs/reference/layouts/partials/assets/javascriptExtras.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<script type="text/javascript" src="{{.Site.BaseUrl}}/lib/bootstrap-toggle/bootstrap-toggle.min.js"></script>
<script type="text/javascript" src="{{.Site.BaseUrl}}/js/java.js"></script>
<script type="text/javascript" src="{{.Site.BaseURL}}/lib/bootstrap-toggle/bootstrap-toggle.min.js"></script>
<script type="text/javascript" src="{{.Site.BaseURL}}/js/java.js"></script>
2 changes: 1 addition & 1 deletion docs/reference/layouts/shortcodes/apiref.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{{ .Page.Site.BaseUrl}}{{ .Page.Site.Data.mongodb.apiUrl }}?{{ with (.Get 0) }}{{ . }}{{ if ne (in . ".html") true}}.html{{ end }}{{ end }}
{{ .Page.Site.BaseURL}}{{ .Page.Site.Data.mongodb.apiUrl }}?{{ with (.Get 0) }}{{ . }}{{ if ne (in . ".html") true}}.html{{ end }}{{ end }}
Loading