-
Notifications
You must be signed in to change notification settings - Fork 345
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.
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
Add redirect for docs #795
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| - title: Config | ||
| key: sonobuoy-config | ||
| destination: sonobuoy-config | ||
| - title: Snapshot Layout | ||
| key: snapshot | ||
| destination: snapshot | ||
| - title: ImagePullSecrets | ||
| key: pullsecrets | ||
| destination: pullsecrets | ||
| - title: Conformance Testing | ||
| key: conformance-testing | ||
| destination: conformance-testing | ||
| - title: Custom Registries & Airgap Testing | ||
| key: airgap | ||
| destination: airgap | ||
| - title: Plugins | ||
| key: plugins | ||
| destination: plugins | ||
| - title: Customization | ||
| key: gen | ||
| destination: gen | ||
| - title: Make your own plugins | ||
| key: examples | ||
| destination: examples | ||
| - title: Cut a release | ||
| key: release | ||
| destination: release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta http-equiv="refresh" content="0; url=/docs/{{ site.latest }}/{{ page.destination }}" /> | ||
| <script type="text/javascript"> | ||
| window.location.href = "/docs/{{ site.latest }}/{{ page.destination }}" | ||
| </script> | ||
| <title>Redirecting...</title> | ||
| </head> | ||
| <body> | ||
| Redirecting to {{ page.destination }}. If it doesn't load, click <a href="/docs/{{ site.latest }}/{{ page.destination }}" />here</a>. | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| # coding: utf-8 | ||
| # Generate pages from individual records in yml files | ||
| # (c) 2014-2016 Adolfo Villafiorita | ||
| # Distributed under the conditions of the MIT License | ||
|
|
||
| module Jekyll | ||
|
|
||
| module Sanitizer | ||
| # strip characters and whitespace to create valid filenames, also lowercase | ||
| def sanitize_filename(name) | ||
| if(name.is_a? Integer) | ||
| return name.to_s | ||
| end | ||
| return name.tr( | ||
| "ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅņŇňʼnŊŋÑñÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝýÿŶŷŸŹźŻżŽž", | ||
| "AAAAAAaaaaaaAaAaAaCcCcCcCcCcDdDdDdEEEEeeeeEeEeEeEeEeGgGgGgGgHhHhIIIIiiiiIiIiIiIiIiJjKkkLlLlLlLlLlNnNnNnNnnNnNnOOOOOOooooooOoOoOoRrRrRrSsSsSsSssTtTtTtUUUUuuuuUuUuUuUuUuUuWwYyyYyYZzZzZz" | ||
| ).downcase.strip.gsub(' ', '-').gsub(/[^\w.-]/, '') | ||
| end | ||
| end | ||
|
|
||
| # this class is used to tell Jekyll to generate a page | ||
| class DataPage < Page | ||
| include Sanitizer | ||
|
|
||
| # - site and base are copied from other plugins: to be honest, I am not sure what they do | ||
| # | ||
| # - `index_files` specifies if we want to generate named folders (true) or not (false) | ||
| # - `dir` is the default output directory | ||
| # - `data` is the data defined in `_data.yml` of the record for which we are generating a page | ||
| # - `name` is the key in `data` which determines the output filename | ||
| # - `template` is the name of the template for generating the page | ||
| # - `extension` is the extension for the generated file | ||
| def initialize(site, base, index_files, dir, data, name, template, extension) | ||
| @site = site | ||
| @base = base | ||
|
|
||
| # @dir is the directory where we want to output the page | ||
| # @name is the name of the page to generate | ||
| # | ||
| # the value of these variables changes according to whether we | ||
| # want to generate named folders or not | ||
| if data[name] == nil | ||
| puts "error (datapage_gen). empty value for field '#{name}' in record #{data}" | ||
| else | ||
| filename = sanitize_filename(data[name]).to_s | ||
|
|
||
| @dir = dir + (index_files ? "/" + filename + "/" : "") | ||
| @name = (index_files ? "index" : filename) + "." + extension.to_s | ||
|
|
||
| self.process(@name) | ||
| self.read_yaml(File.join(base, '_layouts'), template + ".html") | ||
| self.data['title'] = data[name] | ||
| # add all the information defined in _data for the current record to the | ||
| # current page (so that we can access it with liquid tags) | ||
| self.data.merge!(data) | ||
| end | ||
| end | ||
| end | ||
|
|
||
| class DataPagesGenerator < Generator | ||
| safe true | ||
|
|
||
| # generate loops over _config.yml/page_gen invoking the DataPage | ||
| # constructor for each record for which we want to generate a page | ||
|
|
||
| def generate(site) | ||
| # page_gen_dirs determines whether we want to generate index pages | ||
| # (name/index.html) or standard files (name.html). This information | ||
| # is passed to the DataPage constructor, which sets the @dir variable | ||
| # as required by this directive | ||
| index_files = site.config['page_gen-dirs'] == true | ||
|
|
||
| # data contains the specification of the data for which we want to generate | ||
| # the pages (look at the README file for its specification) | ||
| data = site.config['page_gen'] | ||
| if data | ||
| data.each do |data_spec| | ||
| index_files_for_this_data = data_spec['index_files'] != nil ? data_spec['index_files'] : index_files | ||
| template = data_spec['template'] || data_spec['data'] | ||
| name = data_spec['name'] | ||
| dir = data_spec['dir'] || data_spec['data'] | ||
| extension = data_spec['extension'] || "html" | ||
|
|
||
| if site.layouts.key? template | ||
| # records is the list of records defined in _data.yml | ||
| # for which we want to generate different pages | ||
| records = nil | ||
| data_spec['data'].split('.').each do |level| | ||
| if records.nil? | ||
| records = site.data[level] | ||
| else | ||
| records = records[level] | ||
| end | ||
| end | ||
|
|
||
| # apply filtering conditions: | ||
| # - filter requires the name of a boolean field | ||
| # - filter_condition evals a ruby expression | ||
| records = records.select { |r| r[data_spec['filter']] } if data_spec['filter'] | ||
| records = records.select { |record| eval(data_spec['filter_condition']) } if data_spec['filter_condition'] | ||
|
|
||
| records.each do |record| | ||
| site.pages << DataPage.new(site, site.source, index_files_for_this_data, dir, record, name, template, extension) | ||
| end | ||
| else | ||
| puts "error (datapage_gen). could not find template #{template}" if not site.layouts.key? template | ||
| end | ||
| end | ||
| end | ||
| end | ||
| end | ||
|
|
||
| module DataPageLinkGenerator | ||
| include Sanitizer | ||
|
|
||
| # use it like this: {{input | datapage_url: dir}} | ||
| # to generate a link to a data_page. | ||
| # | ||
| # the filter is smart enough to generate different link styles | ||
| # according to the data_page-dirs directive ... | ||
| # | ||
| # ... however, the filter is not smart enough to support different | ||
| # extensions for filenames. | ||
| # | ||
| # Thus, if you use the `extension` feature of this plugin, you | ||
| # need to generate the links by hand | ||
| def datapage_url(input, dir) | ||
| extension = Jekyll.configuration({})['page_gen-dirs'] ? '/' : '.html' | ||
| "#{dir}/#{sanitize_filename(input)}#{extension}" | ||
| end | ||
| end | ||
|
|
||
| end | ||
|
|
||
| Liquid::Template.register_filter(Jekyll::DataPageLinkGenerator) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| --- | ||
| redirect_to: | ||
| - LATEST | ||
| --- |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also need to adjust the URL for the footer: https://github.com/heptio/sonobuoy/pull/795/files#diff-0a55ba953b4a00424ce1150c8cb5e4efR17
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for catching that, I've updated the PR.