tyler.durden
/
icinga-docs-tools
mirror of https://github.com/Icinga/icinga-docs-tools.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add upcoming events to the header

This commit is contained in:
Blerim Sheqa 2018-01-30 10:31:16 +01:00
parent 67cec47cc7
commit 780ec3e48c
3 changed files with 152 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
build-docs.rb
View File

@ -2,6 +2,7 @@
require 'optparse'
require 'fileutils'
require 'yaml'
require 'date'
options = {}
OptionParser.new { |opts|
@ -27,7 +28,7 @@ OptionParser.new { |opts|
end
}.parse!
def clone_and_update_project(target, clone_target, git, ref)
def cleanup_and_clone(target, clone_target, git, ref)
@git_options = "-b #{ref}" if ref =~ /tags/
if !File.directory?(clone_target)
puts "Cloning #{git} to #{clone_target} ..."
@ -39,7 +40,7 @@ def clone_and_update_project(target, clone_target, git, ref)
else
puts "Cleaning up #{clone_target}"
FileUtils::rm_rf(clone_target)
clone_and_update_project(target, clone_target, git, ref)
cleanup_and_clone(target, clone_target, git, ref)
end
end
@ -58,45 +59,73 @@ def build_page_index(full_docs_dir, project_docs_dir)
return pages
end
config = YAML::load_file(options[:config])
def get_events(git, source_dir, categories)
events = []
event_categories = categories
clone_target = source_dir + '/events'
cleanup_and_clone('events', clone_target, git, 'master')
event_categories.each do |category|
category_events = YAML::load_file(clone_target + '/' + category + '.yml')
category_events_sorted = category_events.sort_by { |k| k['start_date'] }
events << category_events_sorted[0]
end
events_sorted = events.sort_by { |k| k['start_date']}
events_sorted.each do |k|
k['start_date'] = Date::ABBR_MONTHNAMES[k['start_date'].month]
end
return events_sorted
end
config = YAML::load_file('config.yml')
project_config = YAML::load_file(options[:config])
mkdocs = YAML::load_file(options[:template])
mkdocs['pages'] = []
puts "== #{config['site_name']}"
version = if config['project']['latest']
puts "== #{project_config['site_name']}"
version = if project_config['project']['latest']
'latest'
elsif config['project']['ref'] == 'master'
elsif project_config['project']['ref'] == 'master'
'snapshot'
else
config['project']['ref'].gsub('tags/', '')
project_config['project']['ref'].gsub('tags/', '')
end
source_dir = config['source_dir'] + '/' + config['project']['target']
source_dir = project_config['source_dir'] + '/' + project_config['project']['target']
clone_target = source_dir + '/' + version
full_docs_dir = clone_target + '/' + config['project']['docs_dir']
full_docs_dir = clone_target + '/' + project_config['project']['docs_dir']
clone_and_update_project(config['project']['target'], clone_target, config['project']['git'], config['project']['ref'])
main_pages = build_page_index(full_docs_dir, config['project']['docs_dir'])
cleanup_and_clone(project_config['project']['target'],
clone_target,
project_config['project']['git'],
project_config['project']['ref'])
main_pages = build_page_index(full_docs_dir, project_config['project']['docs_dir'])
# MKdocs allows only 'index.md' as homepage. This is a dirty workaround to use the first markdown file instead
#FileUtils.ln_s("#{clone_target}/#{main_pages[0].values[0]}", "#{clone_target}/index.md", :force => true)
index_file = "#{clone_target}/index.md"
FileUtils.cp("#{clone_target}/#{main_pages[0].values[0]}", index_file)
index_content = File.read(index_file)
index_new_content = index_content.gsub(/\(((?!http)\S+(\.md|\.png)(\S+)?)\)/, "(#{config['project']['docs_dir']}/\\1)")
index_new_content = index_content.gsub(/\(((?!http)\S+(\.md|\.png)(\S+)?)\)/,
"(#{project_config['project']['docs_dir']}/\\1)")
File.open(index_file, "w") {|file| file.puts index_new_content }
mkdocs['pages'].push('' => "index.md")
if config['project']['subcategories']
if project_config['project']['subcategories']
subcategories = []
config['project']['subcategories'].each do |category, subprojects|
project_config['project']['subcategories'].each do |category, subprojects|
subproject_pages = []
subprojects.each do |project, config|
if config['git']
subproject_clone_target = clone_target + '/' + config['target']
clone_and_update_project(project, subproject_clone_target, config['git'], config['ref'])
cleanup_and_clone(project, subproject_clone_target, config['git'], config['ref'])
end
pages = build_page_index(clone_target + '/' + config['docs_dir'], config['docs_dir'])
@ -106,11 +135,15 @@ if config['project']['subcategories']
end
end
mkdocs['site_name'] = config['site_name']
mkdocs['site_name'] = project_config['site_name']
mkdocs['docs_dir'] = clone_target
mkdocs['site_dir'] = config['site_dir'] + '/' + config['project']['target'] + '/' + version
mkdocs['site_dir'] = project_config['site_dir'] + '/' + project_config['project']['target'] + '/' + version
mkdocs['pages'].push(*main_pages)
mkdocs['pages'].push(*subcategories) if subcategories
mkdocs['extra']['events'] = get_events(config['events']['git'],
config['events']['source_dir'],
config['events']['categories'])
File.write('mkdocs.yml', mkdocs.to_yaml)
%x( mkdocs build )

88
theme/css/theme.css
View File

@ -13,7 +13,7 @@
}
#main-header-container {
width: 80%;
width: 100%;
max-width: 1255px;
margin: auto;
position: relative;
@ -104,7 +104,7 @@
}
.md-header-nav {
width: 80%;
width: 100%;
position: relative;
margin: auto;
padding: 2% 0;
@ -131,12 +131,13 @@
padding: 4px;
padding-bottom: 2px;
height: auto;
margin-bottom: 10px;
}
.md-breadcrump-inner {
position: relative;
margin: auto;
width: 80%;
width: 100%;
padding: 2px;
max-width: 1255px;
}
@ -178,6 +179,87 @@
color: #666;
}
.md-events {
width: 100%;
}
.md-events-inner {
position: relative;
margin: auto;
width: 100%;
max-width: 1255px;
overflow: auto;
border-bottom: 1px solid #ddd;
}
#events-header span{
float: left;
font-size: 12px;
line-height: 22px;
color: #8d8d8d;
}
#events-list {
padding: 0;
padding-bottom: 0.5em;
margin: 0;
}
#events-list li:not(:last-child) {
list-style-type: none;
display: inline-block;
margin-right: 3em;
padding-top: 0.5em;
padding-bottom: 0.5em;
}
#events-list li:last-child {
list-style-type: none;
display: inline-block;
padding-top: 0.5em;
padding-bottom: 0.5em;
}
#events-list li a > *:not(.event-date) {
display: inline-block;
font-size: 12px;
margin: 0;
margin-right: 0.25em;
font-weight: normal;
}
#events-list li a {
color: #333;
}
.event-date {
background-color: #ddd;
color: #333;
border-radius: 4px;
padding: 0.25em 0.7em;
font-size: 1em;
text-transform: uppercase;
letter-spacing: 0.2px;
}
.event-city {
color: #8d8d8d;
}
#events-list li a:hover {
opacity: 0.6;
}
#event-more-link {
float: right;
}
#event-more-link a {
color: #0095bf !important;
line-height: 18px;
font-size: 12px;
}
.md-grid {
max-width: 1255px;

17
theme/partials/header.html
View File

@ -55,4 +55,21 @@
</li>
</ul>
</div>
</div>
<div class="md-events">
<div class="md-events-inner">
<div id="events-header" class="clearfix">
<span>Upcoming Events</span>
</div>
<ul id="events-list">
{% for event in config.extra.events %}
{% if event.name %}
<li class="event-item"><a href="{{ event.registration_link }}"><span class="event-date">{{ event.start_date }}</span> <h3>{{ event.name }}</h3> <span class="event-city">{{ event.city }}</span></a></li>
{% endif %}
{% endfor %}
<li class="event-item" id="event-more-link"><a href="https://www.icinga.com/events/">Show more</a></li>
</ul>
</div>
</div>