Skip to content

Commit 410124c

Browse files
hynekkarZadamsakoumajos
authored
Introduce doc using Jekyll & Update README (#232)
* updated logo * Add "How to use it" page * Add "Developer" page * add "Get options" page * how - remove unnecessary margin * developer - better mark clickable items * add "Export" page * README: Remove per plugin fields Co-authored-by: Damir Zainullin <[email protected]> Co-authored-by: Josef Koumar <[email protected]>
1 parent 6bd0a16 commit 410124c

Some content is hidden

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

91 files changed

+4622
-649
lines changed

‎.gitignore‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,4 +116,8 @@ tests/unit/utils
116116
# vscode settings files
117117
.vscode
118118

119-
119+
# jekyll files
120+
docs/_site/
121+
docs/.sass-cache/
122+
docs/.jekyll-metadata/
123+
docs/.jekyll-cache/

‎README.md‎

Lines changed: 76 additions & 648 deletions
Large diffs are not rendered by default.

‎docs/404.html‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Not Found
3+
description: This does not exist
4+
permalink: /404.html
5+
sitemap: false
6+
---

‎docs/Gemfile‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
source 'https://rubygems.org'
2+
gem "webrick"
3+
gem 'jekyll', '~> 4.2.0'
4+
5+
group :jekyll_plugins do
6+
gem 'jekyll-archives', '~> 2.2.1'
7+
gem 'jekyll-feed', '~> 0.15.1'
8+
gem 'jekyll-paginate', '~> 1.1.0'
9+
gem 'jekyll-seo-tag', '~> 2.7.1'
10+
gem 'jekyll-sitemap', '~> 1.4.0'
11+
end

‎docs/Gemfile.lock‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.7.0)
5+
public_suffix (>= 2.0.2, < 5.0)
6+
colorator (1.1.0)
7+
concurrent-ruby (1.1.9)
8+
em-websocket (0.5.2)
9+
eventmachine (>= 0.12.9)
10+
http_parser.rb (~> 0.6.0)
11+
eventmachine (1.2.7)
12+
ffi (1.15.1)
13+
forwardable-extended (2.6.0)
14+
http_parser.rb (0.6.0)
15+
i18n (1.8.10)
16+
concurrent-ruby (~> 1.0)
17+
jekyll (4.2.0)
18+
addressable (~> 2.4)
19+
colorator (~> 1.0)
20+
em-websocket (~> 0.5)
21+
i18n (~> 1.0)
22+
jekyll-sass-converter (~> 2.0)
23+
jekyll-watch (~> 2.0)
24+
kramdown (~> 2.3)
25+
kramdown-parser-gfm (~> 1.0)
26+
liquid (~> 4.0)
27+
mercenary (~> 0.4.0)
28+
pathutil (~> 0.9)
29+
rouge (~> 3.0)
30+
safe_yaml (~> 1.0)
31+
terminal-table (~> 2.0)
32+
jekyll-archives (2.2.1)
33+
jekyll (>= 3.6, < 5.0)
34+
jekyll-feed (0.15.1)
35+
jekyll (>= 3.7, < 5.0)
36+
jekyll-paginate (1.1.0)
37+
jekyll-sass-converter (2.1.0)
38+
sassc (> 2.0.1, < 3.0)
39+
jekyll-seo-tag (2.7.1)
40+
jekyll (>= 3.8, < 5.0)
41+
jekyll-sitemap (1.4.0)
42+
jekyll (>= 3.7, < 5.0)
43+
jekyll-watch (2.2.1)
44+
listen (~> 3.0)
45+
kramdown (2.3.1)
46+
rexml
47+
kramdown-parser-gfm (1.1.0)
48+
kramdown (~> 2.0)
49+
liquid (4.0.3)
50+
listen (3.5.1)
51+
rb-fsevent (~> 0.10, >= 0.10.3)
52+
rb-inotify (~> 0.9, >= 0.9.10)
53+
mercenary (0.4.0)
54+
pathutil (0.16.2)
55+
forwardable-extended (~> 2.6)
56+
public_suffix (4.0.6)
57+
rb-fsevent (0.11.0)
58+
rb-inotify (0.10.1)
59+
ffi (~> 1.0)
60+
rexml (3.2.5)
61+
rouge (3.26.0)
62+
safe_yaml (1.0.5)
63+
sassc (2.4.0)
64+
ffi (~> 1.9)
65+
terminal-table (2.0.0)
66+
unicode-display_width (~> 1.1, >= 1.1.1)
67+
unicode-display_width (1.7.0)
68+
webrick (1.8.1)
69+
70+
PLATFORMS
71+
ruby
72+
73+
DEPENDENCIES
74+
jekyll (~> 4.2.0)
75+
jekyll-archives (~> 2.2.1)
76+
jekyll-feed (~> 0.15.1)
77+
jekyll-paginate (~> 1.1.0)
78+
jekyll-seo-tag (~> 2.7.1)
79+
jekyll-sitemap (~> 1.4.0)
80+
webrick
81+
82+
BUNDLED WITH
83+
1.17.3

‎docs/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2016-2020 CloudCannon
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎docs/README.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# ipfixprobe website Hydra
2+
3+
Based on Hydra opensource template [live demo](https://proud-alligator.cloudvent.net/)
4+
5+
## Features
6+
7+
* Contact form
8+
* Pre-built pages
9+
* Pre-styled components
10+
* Blog with pagination
11+
* Post category pages
12+
* Disqus comments for posts
13+
* Staff and author system
14+
* Configurable footer
15+
* Optimised for editing in [CloudCannon](http://cloudcannon.com/)
16+
* RSS/Atom feed
17+
* SEO tags
18+
* Google Analytics
19+
20+
## Setup
21+
22+
1. Add your site and author details in `_config.yml`.
23+
2. Add your Google Analytics and Disqus keys to `_config.yml`.
24+
3. Get a workflow going to see your site's output (with [CloudCannon](https://app.cloudcannon.com/) or Jekyll locally).
25+
26+
## Develop
27+
28+
Hydra was built with [Jekyll](http://jekyllrb.com/) version 3.3.1, but should support newer versions as well.
29+
30+
Install the dependencies with [Bundler](http://bundler.io/):
31+
32+
~~~bash
33+
$ bundle install
34+
~~~
35+
36+
Run `jekyll` commands through Bundler to ensure you're using the right versions:
37+
38+
~~~bash
39+
$ bundle exec jekyll serve
40+
~~~
41+
42+
## Editing
43+
44+
Hydra is already optimised for adding, updating and removing pages, staff, advice, company details and footer elements in CloudCannon.
45+
46+
### Posts
47+
48+
* Add, update or remove a post in the *Posts* collection.
49+
* The **Staff Author** field links to members in the **Staff** collection.
50+
* Documentation pages are organised in the navigation by category, with URLs based on the path inside the `_docs` folder.
51+
* Change the defaults when new posts are created in `_posts/_defaults.md`.
52+
53+
### Contact Form
54+
55+
* Preconfigured to work with CloudCannon, but easily changed to another provider (e.g. [FormSpree](https://formspree.io/)).
56+
* Sends email to the address listed in company details.
57+
58+
### Staff
59+
60+
* Reused around the site to save multiple editing locations.
61+
* Add `excluded_in_search: true` to any documentation page's front matter to exclude that page in the search results.
62+
63+
### Navigation
64+
65+
* Exposed as a data file to give clients better access.
66+
* Set in the *Data* / *Navigation* section.
67+
68+
### Footer
69+
70+
* Exposed as a data file to give clients better access.
71+
* Set in the *Data* / *Footer* section.

‎docs/_config.yml‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
# ----
2+
# Site
3+
4+
title: ipfixprobe
5+
url: "https://hynekkar.github.io/ipfixprobe-docs/"
6+
baseurl:
7+
google_analytics_key:
8+
google_maps_javascript_api_key:
9+
disqus_shortname:
10+
11+
# Values for the jekyll-seo-tag gem (https://github.com/jekyll/jekyll-seo-tag)
12+
logo: /siteicon.svg
13+
description: "ipfixprobe is a tool for collecting and processing IPFIX data."
14+
author:
15+
name: "Karel Hynek (CESNET z.s.p.o.)"
16+
email: "[email protected]"
17+
twitter: # twitter username without the @ symbol
18+
social:
19+
name: "Hydra Template"
20+
links:
21+
- https://github.com/CloudCannon/hydra-jekyll-template
22+
23+
# -----
24+
# Build
25+
26+
timezone: Etc/UTC
27+
28+
collections:
29+
staff_members:
30+
_hide_content: true
31+
get_options:
32+
_hide_content: true
33+
how:
34+
_hide_content: true
35+
output: true
36+
export:
37+
_hide_content: true
38+
39+
paginate: 10
40+
paginate_path: "/blog/:num/"
41+
permalink: pretty
42+
43+
defaults:
44+
- scope:
45+
path: ""
46+
type: "posts"
47+
values:
48+
layout: "post"
49+
_options:
50+
content:
51+
width: 1500
52+
height: 2500
53+
- scope:
54+
path: ""
55+
type: "staff_members"
56+
values:
57+
_options:
58+
image_path:
59+
width: 600
60+
height: 600
61+
- scope:
62+
path: ""
63+
values:
64+
layout: "page"
65+
- scope:
66+
path: "index.html"
67+
values:
68+
layout: "default"
69+
- scope:
70+
path: "get_options"
71+
values:
72+
layout: "post"
73+
- scope:
74+
path: "contact.html"
75+
values:
76+
full_width: true
77+
78+
jekyll-archives:
79+
enabled:
80+
- categories
81+
82+
plugins:
83+
- jekyll-archives
84+
- jekyll-sitemap
85+
- jekyll-seo-tag
86+
- jekyll-feed
87+
- jekyll-paginate
88+
89+
exclude:
90+
- Gemfile
91+
- Gemfile.lock
92+
- README.md
93+
- LICENCE
94+
95+
# -----------
96+
# CloudCannon
97+
98+
_select_data:
99+
social_icons:
100+
- Facebook
101+
- Instagram
102+
- LinkedIn
103+
- Pinterest
104+
- Tumblr
105+
- Twitter
106+
- YouTube
107+
- RSS
108+
109+
_comments:
110+
map: Update the map location and display settings.
111+
latitude: Coordinates for the center marker on the map.
112+
longitude: Coordinates for the center marker on the map.
113+
zoom: The zoom level for the map.
114+
pricing_table: Update the information in the pricing tables.
115+
highlight: Emphasis the text
116+
color: The background colour used in the plan name and call to action.
117+
new_window: Open link in new window

‎docs/_data/footer.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
- links:
2+
- name: GitHub
3+
link: https://github.com/CESNET/ipfixprobe
4+
new_window: true
5+
social_icon: GitHub

‎docs/_data/navigation.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
- name: "Get Ipfixprobe"
2+
link: /get_options/
3+
new_window: false
4+
highlight: false
5+
- name: "How to use it"
6+
link: /how/
7+
new_window: false
8+
highlight: false
9+
- name: "Developer"
10+
link: /developer/
11+
new_window: false
12+
highlight: false
13+
- name: "Export Data"
14+
link: /export/
15+
new_window: false
16+
highlight: false

0 commit comments

Comments
 (0)