Skip to content

Commit 242f400

Browse files
rozzarozza
committed
The landing page for user documentation.
http://mongodb.github.io/mongo-java-driver JAVA-1695
1 parent f7278ab commit 242f400

File tree

164 files changed

+37471
-49
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

164 files changed

+37471
-49
lines changed

‎docs/landing/README.md

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
# MongoDB Java Driver Documentation
1+
# MongoDB Java Driver Front page
22

3-
## Quick Start
4-
5-
1. Install hugo
6-
2. Create `./data/mongodb.toml`
7-
3. Create content
3+
The static front page site for the Java documentation portal.
84

95
## Requirements
106
Hugo version 0.13 [download here](https://github.com/spf13/hugo/releases/tag/v0.13)
@@ -29,24 +25,4 @@ For more hugo server options run: `hugo --help`
2925

3026
### Data
3127

32-
You *should* create `./data/mongodb.toml` and copy the `themes/mongodb/data/mongodb.toml` file and set the values as needed.
33-
34-
## Creating new content
35-
36-
Handy [markdown cheat sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Here-Cheatsheet) will help with markdown issues and in markdown you can fall back to html if needed.
37-
38-
To create new content run: `hugo new <contentFileName>.md` and the new file will created in the `./content` directory and marked as a `draft`.
39-
40-
Its a good idea to group similar content together by placing it in a directory which can also be done by the `new` command eg: `hugo new tutorial/newTutorial.md`
41-
42-
### Menus
43-
Menu configuration generally goes in the content
44-
[front matter](http://gohugo.io/content/front-matter/). See the hugo [menu](http://gohugo.io/extras/menus/) docs, menus can also be configured in the top level `config.toml`.
45-
46-
The weight parameter relates to where it will appear in the menu starting with the lowest at the top and the highest at the bottom (heavy things sink).
47-
48-
## MongoDB Theme
49-
**Do not delete / change anything in themes**.<br>
50-
Currently, `./themes/mongodb` provides all templates and configuration. You can override *anything* by providing a top level version in the top level directory (`data, layouts, static`), so feel free to copy or add your own layouts.
51-
52-
You shouldn't edit the mongodb theme directly this will eventually be removed and live in its own repo for ease of sharing.
28+
All dynamic / changing data lives in `./data/mongodb.toml`

‎docs/landing/config.toml

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
baseurl = "/mongo-java-driver/"
22
languageCode = "en-us"
33
title = "MongoDB Java Driver"
4-
theme = "mongodb"
54
canonifyurls = false
65

7-
# Example custom menu Item (Useful for linking to API docs)
8-
# [[menu.main]]
9-
# name = "Issues & Help"
10-
# pre = "<i class='fa fa-life-ring'></i>"
11-
# weight = 100
12-
# identifier = "help"
13-
# url = "https://jira.mongodb.org/browse/JAVA"
6+
githubRepo = "mongo-java-driver"
7+
8+
[params.authors]
9+
[params.authors.Derek]
10+
"firstName" = "Derek"
11+
"lastName" = "Perkins"
12+
[params.authors.Joe]
13+
"firstName" = "Joe"
14+
"lastName" = "Bergevin"
15+
[params.authors.Tanner]
16+
"firstName" = "Tanner"
17+
"lastName" = "Linsley"

‎docs/landing/content/.readme

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
content dir

‎docs/landing/content/index.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎docs/landing/data/.readme

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/landing/data/mongodb.toml

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎docs/landing/data/releases.toml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
current = "3.0.0-rc1"
2+
[[versions]]
3+
version = "3.0.0-rc1"
4+
status = "rc"
5+
docs = "http://mongodb.github.io/mongo-java-driver/3.0"
6+
api = "http://api.mongodb.org/java/3.0"
7+
8+
[[versions]]
9+
version = "2.13.0"
10+
status = "current"
11+
docs = "http://mongodb.github.io/mongo-java-driver/2.13"
12+
api = "http://api.mongodb.org/java/2.13"
13+
14+
[[versions]]
15+
version = "2.12.5"
16+
status = "old"
17+
docs = "http://api.mongodb.org/java/2.12" # We have no plans for a doc site
18+
api = "http://api.mongodb.org/java/2.12"
19+
20+
[[drivers]]
21+
name = "mongodb-driver"
22+
description = "The synchronous driver."
23+
24+
[[drivers]]
25+
name = "mongodb-driver-async"
26+
description = "The new asynchronous driver."
27+
28+
[[drivers]]
29+
name = "mongo-java-driver"
30+
description = "An uber jar containing the bson library, the core library and the mongodb-driver."
31+
32+
[[drivers]]
33+
name = "mongodb-driver-core"
34+
description = "The core library."

‎docs/landing/layouts/404.html

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
{{ partial "meta.html"}}
5+
<link rel="shortcut icon" href="{{.Site.BaseUrl}}/img/favicon.png">
6+
7+
<title>{{.Title}}</title>
8+
9+
{{ partial "assets/css.html" . }}
10+
</head>
11+
12+
<body>
13+
<!--header start-->
14+
{{ partial "header/main.html" . }}
15+
<!--header end-->
16+
17+
<div id="promo" class="jumbotron">
18+
<div class="container">
19+
<div class="row">
20+
<div class="col-md-2"></div>
21+
<div class="col-md-6">
22+
<h1>404: Page not found</h1>
23+
</div>
24+
<div class="col-md-2" id="mongodbJVMlogo"></div>
25+
</div>
26+
</div>
27+
</div>
28+
29+
30+
<!-- Footer -->
31+
<div class="container">
32+
<div class="row">
33+
<div class="col-md-12">
34+
{{ partial "footer.html" .}}
35+
</div>
36+
</div>
37+
</div>
38+
<!-- End footer -->
39+
40+
41+
<!-- javascripts -->
42+
{{ partial "assets/javascripts.html" . }}
43+
{{ partial "assets/analytics.html" . }}
44+
</body>
45+
</html>

‎docs/landing/layouts/index.html

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
{{ partial "meta.html"}}
5+
<link rel="shortcut icon" href="{{.Site.BaseUrl}}/img/favicon.png">
6+
7+
<title>{{.Title}}</title>
8+
9+
{{ partial "assets/css.html" . }}
10+
</head>
11+
12+
<body>
13+
<!--header start-->
14+
{{ partial "header/main.html" . }}
15+
<!--header end-->
16+
17+
{{ partial "hero.html" . }}
18+
19+
<!-- Main content -->
20+
<div class="container" id="mainContent">
21+
<div class="row">
22+
<div class="col-md-8">
23+
{{ partial "introduction.html" . }}
24+
25+
{{ partial "features.html" . }}
26+
27+
{{ partial "quickStart.html" . }}
28+
</div>
29+
<div class="col-md-4">
30+
{{ partial "releases.html" . }}
31+
{{ partial "mongodbUniversity.html" . }}
32+
</div>
33+
</div>
34+
</div>
35+
<!-- End main content -->
36+
37+
<!-- Footer -->
38+
<div class="container">
39+
<div class="row">
40+
<div class="col-md-12">
41+
{{ partial "footer.html" .}}
42+
</div>
43+
</div>
44+
</div>
45+
<!-- End footer -->
46+
47+
48+
<!-- javascripts -->
49+
{{ partial "assets/javascripts.html" . }}
50+
{{ partial "assets/analytics.html" . }}
51+
</body>
52+
</html>

‎docs/landing/layouts/partials/assets/analytics.html

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Google Tag Manager -->
2+
<noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-MNSSXD"
3+
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
4+
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push(
5+
{'gtm.start': new Date().getTime(),event:'gtm.js'}
6+
);var f=d.getElementsByTagName(s)[0],
7+
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
8+
'//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
9+
})(window,document,'script','dataLayer','GTM-MNSSXD');</script>
10+
<!-- End Google Tag Manager -->
11+
12+
<script type="text/javascript">
13+
var _elqQ = _elqQ || [];
14+
_elqQ.push(['elqSetSiteId', '413370795']);
15+
_elqQ.push(['elqTrackPageView']);
16+
(function () {
17+
function async_load()
18+
{ var s = document.createElement('script'); s.type = 'text/javascript'; s.async = true; s.src = '//img03.en25.com/i/elqCfg.min.js'; var x = document.getElementsByTagName('script')[0]; x.parentNode.insertBefore(s, x); }
19+
if (window.addEventListener) window.addEventListener('DOMContentLoaded', async_load, false);
20+
else if (window.attachEvent) window.attachEvent('onload', async_load);
21+
})();
22+
</script>

0 commit comments

Comments
 (0)