diff --git a/Dockerfile b/Dockerfile index 7eed201a6..b009528f7 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,11 +1,11 @@ -FROM jekyll/builder +FROM jekyll/builder:4.1.0 WORKDIR /tmp ADD Gemfile /tmp/ ADD Gemfile.lock /tmp/ RUN bundle install -FROM jekyll/jekyll +FROM jekyll/jekyll:4.1.0 VOLUME /src EXPOSE 4000 diff --git a/Gemfile.lock b/Gemfile.lock index ba4e04593..25a21166c 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -240,9 +240,10 @@ GEM PLATFORMS ruby + x86_64-linux-musl DEPENDENCIES github-pages BUNDLED WITH - 2.0.1 + 2.2.2 diff --git a/_config.yml b/_config.yml index 98d81bbb5..37c17a824 100644 --- a/_config.yml +++ b/_config.yml @@ -1,24 +1,24 @@ -repository: tomjoht/documentation-theme-jekyll +repository: hobbit-project/platform output: web # this property is useful for conditional filtering of content that is separate from the PDF. -topnav_title: Jekyll Documentation Theme +topnav_title: HOBBIT Documentation # this appears on the top navigation bar next to the home button -site_title: Jekyll theme for documentation +site_title: HOBBIT Project and Platform Documentation # this appears in the html browser tab for the site title (seen mostly by search engines, not users) -company_name: Your company +company_name: HOBBIT Partners (maintained by InfAI) # this appears in the footer -github_editme_path: tomjoht/documentation-theme-jekyll/blob/gh-pages/ -# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank. - -# gitlab_editme_path: tomjoht/documentation-theme-jekyll/blob/gh-pages/ +# gitlab_editme_path: hobbit-project/hobbit-project.github.io/blob/master/ # if you're using GitLab, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank. -google_analytics: UA-66296557-1 +#disqus_shortname: idratherbewriting +# if you're using disqus for comments, add the shortname here. if not, leave this value blank. + +#google_analytics: UA-66296557-1 # if you have google-analytics ID, put it in. if not, edit this value to blank. host: 127.0.0.1 @@ -33,9 +33,7 @@ exclude: - vendor # these are the files and directories that jekyll will exclude from the build -feedback_subject_line: Jekyll documentation theme - -feedback_email: tomjoht@gmail.com +feedback_link: https://github.com/hobbit-project/hobbit-project.github.io/issues # used as a contact email for the Feedback link in the top navigation bar # feedback_disable: true @@ -71,10 +69,10 @@ defaults: type: "pages" values: layout: "page" - comments: true + comments: false # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property search: true - sidebar: home_sidebar + sidebar: main_sidebar topnav: topnav - scope: @@ -90,28 +88,24 @@ defaults: path: "" type: "posts" values: - layout: "post" - comments: true + layout: "page" + comments: false # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property search: true - sidebar: home_sidebar + sidebar: main_sidebar topnav: topnav # these are defaults used for the frontmatter for these file types sidebars: - home_sidebar -- mydoc_sidebar -- product1_sidebar -- product2_sidebar -- other -description: "Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features." +description: "HOBBIT Project Documentation." # the description is used in the feed.xml file # needed for sitemap.xml file only -# url: http://idratherbewriting.com -# baseurl: /documentation-theme-jekyll +url: https://hobbit-project.github.io/ +baseurl: "" github: [metadata] diff --git a/_data/sidebars/home_sidebar.yml b/_data/sidebars/home_sidebar.yml deleted file mode 100644 index fbf43d51f..000000000 --- a/_data/sidebars/home_sidebar.yml +++ /dev/null @@ -1,22 +0,0 @@ -# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting. - -entries: -- title: Sidebar - levels: one - folders: - - - title: Products - output: web - folderitems: - - title: News - url: /news.html - output: web - - title: Theme instructions - url: /mydoc_introduction.html - output: web - - title: Product 1 - url: /p1_landing_page.html - output: web - - title: Product 2 - url: /p2_landing_page.html - output: web diff --git a/_data/sidebars/main_sidebar.yml b/_data/sidebars/main_sidebar.yml new file mode 100644 index 000000000..4c8602a2e --- /dev/null +++ b/_data/sidebars/main_sidebar.yml @@ -0,0 +1,224 @@ +# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting. + +entries: +- title: sidebar +# product: HOBBIT Documentation +# version: 2.0 + folders: + + - title: + output: pdf + type: frontmatter + folderitems: + - title: + url: /titlepage.html + output: pdf + type: frontmatter + - title: + url: /tocpage.html + output: pdf + type: frontmatter + + - title: Introduction + url: /index.html + output: toplevel, pdf + type: homepage + + - title: Platform Overview + url: /overview.html + output: toplevel, pdf + + - title: Tutorials + output: web, pdf + folderitems: + + - title: Quick Guide + url: /quick_guide.html + output: web, pdf + + - title: Deployment with Exoframe + url: /exoframe.html + output: web, pdf + + - title: master.project-hobbit.eu + url: /master.html + output: web, pdf + + - title: Benchmarking a System + url: /benchmarking.html + output: web, pdf + + - title: Browsing Results + url: /browsing_results.html + output: web, pdf + + - title: Taking Part in Challenge + url: /challenge_participation.html + output: web, pdf + + - title: Organizing a Challenge + url: /challenge_organization.html + output: web, pdf + + - title: How to Integrate a System + url : /system_integration.html + output: web, pdf + + - title: How to Integrate a Benchmark + url : /benchmark_integration.html + output: web, pdf + + - title: Using Java SDK to develop a Benchmark + url : /java_sdk.html + output: web, pdf + + - title: Data License + url : /data_license + output: web, pdf + + - title: Reference Manual + output: web, pdf + folderitems: + + - title: Workflow of an Experiment + url: /experiment_workflow.html + output: web, pdf + + subfolders: + - title: Platform Deployment + output: web, pdf + subfolderitems: + + - title: Requirements + url: /requirements.html + output: web, pdf + + - title: On a Single Machine + url: /platform_deployment_single_machine.html + output: web, pdf + + - title: On a Cluster + url: /platform_deployment_cluster.html + output: web, pdf + + - title: Troubleshooting + url: /troubleshooting.html + output: web, pdf + + - title: Optional platform features + url: /optional_features.html + output: web, pdf + + - title: Env. Variables + url: /parameters_env.html + output: web, pdf + + - title: Platform Config File + url: /parameters_config.html + output: web, pdf + + - title: Volumes + url: /parameters_volumes.html + output: web, pdf + + - title: storage-init.sh + url: /parameters_storage_init.html + output: web, pdf + + - title: Frontend configuration + url: /parameters_frontend.html + output: web, pdf + + - title: GPU configuration + url: /gpu.html + output: web, pdf + + - title: Platform Components + output: web, pdf + subfolderitems: + + - title: Platform Controller + url: /platform_controller_component.html + output: web, pdf + + - title: Storage + url: /storage_component.html + output: web, pdf + + - title: Frontend + url: /frontend_component.html + output: web, pdf + + - title: User Management + url: /user_management_component.html + output: web, pdf + + - title: Repository + url: /repository_component.html + output: web, pdf + + - title: Analysis + url: /analysis_component.html + output: web, pdf + + - title: Message Bus + url: /message_bus_component.html + output: web, pdf + + - title: Logging + url: /logging_component.html + output: web, pdf + + - title: Resource Monitoring + url: /monitoring_component.html + output: web, pdf + + - title: Internal Challenge Workflow + url: /internal_challenge_workflow.html + output: web, pdf + + - title: Core Library + output: web, pdf + subfolderitems: + + - title: Java Components + url: /java_components.html + output: web, pdf + + - title: Command Queue + url: /command_queue.html + output: web, pdf + + - title: Transferring Data + url: /transferring_data.html + output: web, pdf + + - title: General Platform API + url: /platform_api.html + output: web, pdf + + - title: Integrating a System + url: /system_integration_api.html + output: web, pdf + + - title: Integrating a Benchmark + url: /benchmark_integration_api.html + output: web, pdf + + - title: FAQ + url: /faq.html + output: web, pdf + + - title: Challenges + output: web, pdf + folderitems: + + - title: Challenge Overview + url: /challenge_overview.html + output: web, pdf + + - title: OAEI 2023 + url: /OAEI_2023.html + output: web, pdf + + diff --git a/_data/sidebars/mydoc_sidebar.yml b/_data/sidebars/mydoc_sidebar.yml deleted file mode 100644 index fe506cd4c..000000000 --- a/_data/sidebars/mydoc_sidebar.yml +++ /dev/null @@ -1,295 +0,0 @@ -# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting. - -entries: -- title: sidebar - product: Jekyll Doc Theme - version: 6.0 - folders: - - - title: - output: pdf - type: frontmatter - folderitems: - - title: - url: /titlepage.html - output: pdf - type: frontmatter - - title: - url: /tocpage.html - output: pdf - type: frontmatter - - - title: Overview - output: web, pdf - folderitems: - - - title: Get started - url: /index.html - output: web, pdf - type: homepage - - - title: Introduction - url: /mydoc_introduction.html - output: web, pdf - - - title: Supported features - url: /mydoc_supported_features.html - output: web, pdf - - - title: About the theme author - url: /mydoc_about.html - output: web, pdf - - - title: Support - url: /mydoc_support.html - output: web, pdf - - - title: Release Notes - output: web, pdf - folderitems: - - - title: 6.0 Release notes - url: /mydoc_release_notes_60.html - output: web, pdf - - - title: 5.0 Release notes - url: /mydoc_release_notes_50.html - output: web, pdf - - - title: Installation - output: web, pdf - folderitems: - - - title: About Ruby, Gems, Bundler, etc. - url: /mydoc_about_ruby_gems_etc.html - output: web, pdf - - - title: Install Jekyll on Mac - url: /mydoc_install_jekyll_on_mac.html - output: web, pdf - - - title: Install Jekyll on Windows - url: /mydoc_install_jekyll_on_windows.html - output: web, pdf - - - title: Authoring - output: web, pdf - - folderitems: - - title: Pages - url: /mydoc_pages.html - output: web, pdf - - - title: Posts - url: /mydoc_posts.html - output: web, pdf - - - title: Lists - url: /mydoc_lists.html - output: web, pdf - - - title: Conditional logic - url: /mydoc_conditional_logic.html - output: web, pdf - - - title: Content reuse - url: /mydoc_content_reuse.html - output: web, pdf - - - title: Collections - url: /mydoc_collections.html - output: web, pdf - - - title: WebStorm editor tips - url: /mydoc_webstorm_text_editor.html - output: web, pdf - - - title: Atom editor tips - url: /mydoc_atom_text_editor.html - output: web, pdf - - - title: Navigation - output: web, pdf - - folderitems: - - title: Sidebar navigation - url: /mydoc_sidebar_navigation.html - output: web, pdf - - - title: YAML tutorial in the context of Jekyll - url: /mydoc_yaml_tutorial.html - output: web, pdf - - - title: Tags - url: /mydoc_tags.html - output: web, pdf - - - title: Series - url: /mydoc_series.html - output: web, pdf - - - title: Formatting - output: web, pdf - - folderitems: - - title: Tooltips - url: /mydoc_adding_tooltips.html - output: web, pdf - - - title: Alerts - url: /mydoc_alerts.html - output: web, pdf - - - title: Icons - url: /mydoc_icons.html - output: web, pdf - - - title: Images - url: /mydoc_images.html - output: web, pdf - - - title: Code samples - url: /mydoc_code_samples.html - output: web, pdf - - - title: Labels - url: /mydoc_labels.html - output: web, pdf - - - title: Links - url: /mydoc_hyperlinks.html - output: web, pdf - - - title: Navtabs - url: /mydoc_navtabs.html - output: web, pdf - - - title: Tables - url: /mydoc_tables.html - output: web, pdf - - - title: Syntax highlighting - url: /mydoc_syntax_highlighting.html - output: web, pdf - - - title: Workflow maps - url: /mydoc_workflow_maps.html - output: web, pdf - - - title: Handling reviews - output: web, pdf - - folderitems: - - title: Commenting on files - url: /mydoc_commenting_on_files.html - output: web, pdf - -# - title: Git collaboration -# url: /mydoc_git_collaboration -# output: web, pdf - - - title: Publishing - output: web, pdf - - folderitems: - - title: Build arguments - url: /mydoc_build_arguments.html - output: web, pdf - - - title: Themes - url: /mydoc_themes.html - output: web, pdf - - - title: Generating PDFs - url: /mydoc_generating_pdfs.html - output: web, pdf - - - title: Help APIs and UI tooltips - url: /mydoc_help_api.html - output: web, pdf - - - title: Search configuration - url: /mydoc_search_configuration.html - output: web, pdf - - - title: iTerm profiles - url: /mydoc_iterm_profiles.html - output: web, pdf - - - title: Pushing builds to server - url: /mydoc_push_build_to_server.html - output: web, pdf - - - title: Publishing on Github Pages - url: /mydoc_publishing_github_pages.html - output: web, pdf - - - title: Special layouts - output: web, pdf - - folderitems: - - title: Knowledge-base layout - url: /mydoc_kb_layout.html - output: web, pdf - - - title: Glossary layout - url: /mydoc_glossary.html - output: web, pdf - - - title: FAQ layout - url: /mydoc_faq_layout.html - output: web, pdf - - - title: Shuffle layout - url: /mydoc_shuffle.html - output: web, pdf - - - title: Troubleshooting - output: web, pdf - - folderitems: - - - title: Troubleshooting - url: /mydoc_troubleshooting.html - output: web, pdf - - - title: Tag archives - output: web - folderitems: - - - title: Tag archives overview - url: /mydoc_tag_archives_overview.html - output: web - - subfolders: - - title: Tag archive pages - output: web - subfolderitems: - - - title: Formatting pages - url: /tag_formatting.html - output: web - - - title: Navigation pages - url: /tag_navigation.html - output: web - - - title: Content types pages - url: /tag_content_types.html - output: web - - - title: Publishing pages - url: /tag_publishing.html - output: web - - - title: Special layout pages - url: /tag_special_layouts.html - output: web - - - title: Collaboration pages - url: /tag_collaboration.html - output: web - - - title: Troubleshooting pages - url: /tag_troubleshooting.html - output: web diff --git a/_data/sidebars/other.yml b/_data/sidebars/other.yml deleted file mode 100644 index 4be86f03b..000000000 --- a/_data/sidebars/other.yml +++ /dev/null @@ -1,18 +0,0 @@ - -# Follow the pattern here for the URLs -- no slash at the beginning, and include the .html. The link here is rendered exactly as is in the Markdown references. - -entries: -- title: other - folders: - - - title: Other Links - folderitems: - - - title: Automated links bookmark - url: /mydoc_hyperlinks.html#automatedlinks - - - title: Bookmark links - url: /mydoc_hyperlinks.html#bookmarklinks - - - title: Some link bookmark - url: /mydoc_pages.html#someIdTag diff --git a/_data/sidebars/product1_sidebar.yml b/_data/sidebars/product1_sidebar.yml deleted file mode 100644 index 4a04389f7..000000000 --- a/_data/sidebars/product1_sidebar.yml +++ /dev/null @@ -1,60 +0,0 @@ -# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting. - - -entries: -- title: Sidebar - product: Product1 - version: 1.0 - folders: - - - title: - output: pdf - type: frontmatter - folderitems: - - title: - url: /titlepage.html - output: pdf - type: frontmatter - - title: - url: /tocpage.html - output: pdf - type: frontmatter - - - title: Getting Started - output: web, pdf - folderitems: - - title: Product 1 home - url: /p1_landing_page.html - output: web - - - title: Sample 1 - url: /p1_sample1.html - output: web, pdf - - - title: Sample 2 - url: /p1_sample2.html - output: web, pdf - - - title: Sample 3 - url: /p1_sample3.html - output: web, pdf - - - title: Another heading - output: web, pdf - - folderitems: - - title: Sample 4 - url: /p1_sample4.html - output: web, pdf - - - title: Sample 5 - url: /p1_sample5.html - output: web, pdf - - - title: Sample 6 - url: /p1_sample6.html - output: web, pdf - - - title: Sample 7 - url: /p1_sample7.html - output: web, pdf diff --git a/_data/sidebars/product2_sidebar.yml b/_data/sidebars/product2_sidebar.yml deleted file mode 100644 index ca80dbbbf..000000000 --- a/_data/sidebars/product2_sidebar.yml +++ /dev/null @@ -1,92 +0,0 @@ -# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting. - -entries: -- title: Product2 - product: Product2 - version: 1.0 - folders: - - - title: - output: pdf - type: frontmatter - folderitems: - - title: - url: /titlepage.html - output: pdf - type: frontmatter - - title: - url: /tocpage.html - output: pdf - type: frontmatter - - - title: Introduction - output: web, pdf - folderitems: - - - title: Overview - url: /p2_landing_page.html - output: web - - - title: Simple Workflow - output: web, pdf - folderitems: - - - title: Sample 1 - url: /p2_sample1.html - output: web, pdf - - - title: Sample 2 - url: /p2_sample2.html - output: web, pdf - - - title: Sample 3 - url: /p2_sample3.html - output: web, pdf - - - title: Sample 4 - url: /p2_sample4.html - output: web, pdf - - - title: Sample 5 - url: /p2_sample5.html - output: web, pdf - - - title: Complex Workflow - output: web, pdf - folderitems: - - - title: Sample 6 - url: /p2_sample6.html - output: web, pdf - - - title: Sample 7 - url: /p2_sample7.html - output: web, pdf - - - title: Sample 8 - url: /p2_sample8.html - output: web, pdf - - - title: Sample 9 - url: /p2_sample9.html - output: web, pdf - - - title: Sample 10 - url: /p2_sample10.html - output: web, pdf - - - title: Sample 11 - url: /p2_sample11.html - output: web, pdf - - - title: Sample 12 - url: /p2_sample12.html - output: web, pdf - - - title: Sample 13 - url: /p2_sample13.html - output: web, pdf - - - title: Sample 14 - url: /p2_sample14.html - output: web, pdf diff --git a/_data/topnav.yml b/_data/topnav.yml index 1e4036150..6bdbf4700 100644 --- a/_data/topnav.yml +++ b/_data/topnav.yml @@ -1,32 +1,9 @@ ## Topnav single links ## if you want to list an external url, use external_url instead of url. the theme will apply a different link base. -topnav: -- title: Topnav - items: - - title: GitHub - external_url: https://github.com/tomjoht/documentation-theme-jekyll - - title: News - url: /news - -#Topnav dropdowns -topnav_dropdowns: -- title: Topnav dropdowns - folders: - - title: Jekyll Help - folderitems: - - title: Jekyll Talk - external_url: https://talk.jekyllrb.com - - title: Jekyll documentation - external_url: http://jekyllrb.com/docs/home/ - - title: Jekyll on Stack Overflow - external_url: http://stackoverflow.com/questions/tagged/jekyll - - title: Jekyll on my blog - external_url: http://idratherbewriting.com/category-jekyll/ - - title: Products - folderitems: - - title: Jekyll Documentation Theme - url: /mydoc_introduction.html - - title: Product 1 - url: /p1_landing_page.html - - title: Product 2 - url: /p2_landing_page.html +# topnav: +# - title: Topnav +# items: +# - title: GitHub +# external_url: https://github.com/hobbit-project +# - title: HOBBIT Documentation +# url: /introduction.html diff --git a/_includes/footer.html b/_includes/footer.html old mode 100755 new mode 100644 index 1682c9617..3c932d9ce --- a/_includes/footer.html +++ b/_includes/footer.html @@ -3,7 +3,7 @@ diff --git a/_includes/sidebar.html b/_includes/sidebar.html index 109705b3a..ef81df8e7 100644 --- a/_includes/sidebar.html +++ b/_includes/sidebar.html @@ -4,6 +4,9 @@
  • {{sidebar[0].product}} {{sidebar[0].version}}
  • {% for entry in sidebar %} {% for folder in entry.folders %} + {% if folder.output contains "toplevel" %} + {{ folder.title }} + {% endif %} {% if folder.output contains "web" %}
  • {{folder.title}} diff --git a/_includes/topnav.html b/_includes/topnav.html index a246c29f8..d829625d5 100644 --- a/_includes/topnav.html +++ b/_includes/topnav.html @@ -8,7 +8,7 @@ -   {{site.topnav_title}} +   {{site.topnav_title}}