From 49bf9a0d75a2faba743eb6c893e53500f258efeb Mon Sep 17 00:00:00 2001
From: nesdis <nesdis@gmail.com>
Date: Sun, 23 Aug 2020 20:52:58 +0200
Subject: [PATCH] Improved documentation
---
.gitignore | 1 -
docs/_config.yml | 1 +
docs/_includes/feedback.html | 14 ++++++
docs/_includes/head/custom.html | 43 +------------------
docs/_includes/head/google-tag-manager.html | 8 ++++
docs/_includes/head/hotjar.html | 10 +++++
docs/_includes/pizza.html | 6 +++
docs/_sass/sponsor-tire.scss | 1 +
.../sponsor-tire/_tire.scss} | 25 +++++++----
docs/assets/css/custom.scss | 5 +++
docs/docs/get-started.md | 1 +
11 files changed, 63 insertions(+), 52 deletions(-)
create mode 100644 docs/_includes/feedback.html
create mode 100644 docs/_includes/head/google-tag-manager.html
create mode 100644 docs/_includes/head/hotjar.html
create mode 100644 docs/_includes/pizza.html
create mode 100644 docs/_sass/sponsor-tire.scss
rename docs/{assets/css/sponsor-tire.css => _sass/sponsor-tire/_tire.scss} (87%)
create mode 100644 docs/assets/css/custom.scss
diff --git a/.gitignore b/.gitignore
index b35a3a1..41d59b1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -13,7 +13,6 @@ docs/.sass-cache/*
docs/_apidocs/_build/
docs/_apidocs/doctrees/
docs/_layouts/*
-docs/_sass/*
docs/_site/*
docs/assets/js/*
!docs/assets/js/jquery.liquid-slider.min.js
diff --git a/docs/_config.yml b/docs/_config.yml
index 496a219..0904654 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -130,6 +130,7 @@ plugins:
- jekyll-gist
- jemoji
- jekyll-include-cache
+ - jekyll-redirect-from
# mimic GitHub Pages with --safe
whitelist:
diff --git a/docs/_includes/feedback.html b/docs/_includes/feedback.html
new file mode 100644
index 0000000..fb36f18
--- /dev/null
+++ b/docs/_includes/feedback.html
@@ -0,0 +1,14 @@
+<div class="toc feedback">
+<header><h4 class="nav__title"><i class="fas fa-{{ page.toc_icon | default: 'file-alt' }}"></i> Rate the Docs</h4></header>
+<form action="https://formspree.io/nesdis@gmail.com" method="POST">
+ <select name="rating">
+ <option value="1">1 (Sucks)</option>
+ <option value="2">2</option>
+ <option value="3" selected>3</option>
+ <option value="4">4</option>
+ <option value="4">5 (Awesome)</option>
+ </select>
+ <textarea name="feedback" rows="5" cols="30">Feedback</textarea>
+ <input type="submit" value="Send">
+</form>
+</div>
\ No newline at end of file
diff --git a/docs/_includes/head/custom.html b/docs/_includes/head/custom.html
index df3afff..015fb4c 100644
--- a/docs/_includes/head/custom.html
+++ b/docs/_includes/head/custom.html
@@ -1,45 +1,4 @@
<!-- start custom head snippets -->
-
-<!-- Google Tag Manager
-<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
-new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
-j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
-'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
-})(window,document,'script','dataLayer','GTM-T72KG6N');</script>
-
-End Google Tag Manager -->
-<!--
-<script>
- (function(h,o,t,j,a,r){
- h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};
- h._hjSettings={hjid:817955,hjsv:6};
- a=o.getElementsByTagName('head')[0];
- r=o.createElement('script');r.async=1;
- r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;
- a.appendChild(r);
- })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
-</script>
--->
-<link rel="stylesheet" type="text/css" media="screen" href="/djongo/assets/css/sponsor-tire.css">
-
-<!--<script src="/djongo/assets/js/jquery.min.js"></script>-->
-<!--<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>-->
-<!-- <script src="/djongo/assets/js/main.min.js"></script> -->
-<!--<script>-->
- <!--$(function(){-->
-
- <!--/* Here is the slider using default settings */-->
- <!--$('#slider-1').liquidSlider({-->
- <!--autoSlide:true,-->
- <!--autoHeight:false,-->
- <!--autoSlideInterval: 4000,-->
- <!--forceAutoSlide: true,-->
- <!--dynamicTabs: false-->
-
-
- <!--});-->
- <!--});-->
-<!--</script>-->
-<!-- insert favicons. use http://realfavicongenerator.net/ -->
+<link rel="stylesheet" type="text/css" media="screen" href="{{'/assets/css/custom.css' | relative_url}}">
<!-- end custom head snippets -->
\ No newline at end of file
diff --git a/docs/_includes/head/google-tag-manager.html b/docs/_includes/head/google-tag-manager.html
new file mode 100644
index 0000000..75daa1b
--- /dev/null
+++ b/docs/_includes/head/google-tag-manager.html
@@ -0,0 +1,8 @@
+
+<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+})(window,document,'script','dataLayer','GTM-T72KG6N');</script>
+
+End Google Tag Manager -->
\ No newline at end of file
diff --git a/docs/_includes/head/hotjar.html b/docs/_includes/head/hotjar.html
new file mode 100644
index 0000000..3bc3fd9
--- /dev/null
+++ b/docs/_includes/head/hotjar.html
@@ -0,0 +1,10 @@
+<script>
+ (function(h,o,t,j,a,r){
+ h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};
+ h._hjSettings={hjid:817955,hjsv:6};
+ a=o.getElementsByTagName('head')[0];
+ r=o.createElement('script');r.async=1;
+ r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;
+ a.appendChild(r);
+ })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
+</script>
\ No newline at end of file
diff --git a/docs/_includes/pizza.html b/docs/_includes/pizza.html
new file mode 100644
index 0000000..6d31baa
--- /dev/null
+++ b/docs/_includes/pizza.html
@@ -0,0 +1,6 @@
+{% if page.pizza %}
+ <aside class="sidebar__right" style="position: sticky; top: 2em; float: right">
+ <header><h4 class="nav__title"><i class="fas fa-{{ page.toc_icon | default: 'file-alt' }}"></i> Buy ME A Pizza</h4></header>
+ <a href="https://www.patreon.com/posts/buy-me-pizza-26095081"><img src="/djongo/assets/images/pizza.jpg"></a>
+ </aside>
+{% endif %}
\ No newline at end of file
diff --git a/docs/_sass/sponsor-tire.scss b/docs/_sass/sponsor-tire.scss
new file mode 100644
index 0000000..7f89558
--- /dev/null
+++ b/docs/_sass/sponsor-tire.scss
@@ -0,0 +1 @@
+@import "sponsor-tire/tire";
\ No newline at end of file
diff --git a/docs/assets/css/sponsor-tire.css b/docs/_sass/sponsor-tire/_tire.scss
similarity index 87%
rename from docs/assets/css/sponsor-tire.css
rename to docs/_sass/sponsor-tire/_tire.scss
index 5b9e8bd..ff321be 100644
--- a/docs/assets/css/sponsor-tire.css
+++ b/docs/_sass/sponsor-tire/_tire.scss
@@ -5,25 +5,36 @@
justify-content: center;
}
-.tire_item__box {
+.tire__banner {
+ height: 100px;
+}
+
+%box-border {
border-style: solid;
border-width: 1px;
border-color: rgb(229, 227, 221);
border-radius: 4px;
+}
+%box-spacing {
margin-bottom: 2em;
margin-left: 1em;
margin-right: 1em;
padding: 1em;
+}
+
+.tire_item__box {
+ @extend %box-border;
+ @extend %box-spacing;
+
width: 29%;
min-width: 16em;
-
text-align: center;
-}
-.tire_item__box ul {
- text-align: left;
+ ul {
+ text-align: left;
+ }
}
.tire_item__title {
@@ -52,7 +63,3 @@
margin-right: 0;
}
}
-
-.tire__banner {
- height: 100px;
-}
\ No newline at end of file
diff --git a/docs/assets/css/custom.scss b/docs/assets/css/custom.scss
new file mode 100644
index 0000000..cd6993c
--- /dev/null
+++ b/docs/assets/css/custom.scss
@@ -0,0 +1,5 @@
+---
+# this ensures Jekyll reads the file to be transformed into CSS later
+---
+
+@import "sponsor-tire";
\ No newline at end of file
diff --git a/docs/docs/get-started.md b/docs/docs/get-started.md
index b2f86c9..e7cfc38 100644
--- a/docs/docs/get-started.md
+++ b/docs/docs/get-started.md
@@ -1,6 +1,7 @@
---
title: Integrating Django with MongoDB
permalink: /get-started/
+redirect_from: /integrating-django-with-mongodb/
description: "Djongo is a python connector for using the Django ORM with MongoDB. Use MongoDB as a backend database for your Django project, without changing the Django ORM. Start using Django with MongoDB by adding just one line of code"
---
--
GitLab