From f057e63221d258abcaeed64277e20416bd173b80 Mon Sep 17 00:00:00 2001 From: Mykel Alvis Date: Fri, 15 Nov 2024 07:46:57 -0600 Subject: [PATCH] Initial (and incomplete) commit --- .devcontainer/Dockerfile | 7 + .devcontainer/devcontainer.json | 5 + .gitattributes | 5 + .github/dependabot.yml | 15 + .github/workflows/sync_theme.yml | 52 ++++ .gitignore | 9 + .gitmodules | 7 + Gemfile | 5 + README.md | 49 +++ _config.yml | 160 ++++++++++ _config_dev.yml | 12 + _data/alerts.yml | 15 + _data/definitions.yml | 9 + _data/glossary.yml | 11 + _data/samplelist.yml | 107 +++++++ _data/sidebars/sidebar_ioos.yml | 92 ++++++ _data/strings.yml | 5 + _data/tags.yml | 12 + _data/terms.yml | 1 + _docs/howto.md | 293 ++++++++++++++++++ _docs/images/IOOS_Emblem_Primary_B_RGB.jpg | Bin 0 -> 153058 bytes .../IOOS_Emblem_Primary_B_RGB_small.png | Bin 0 -> 15632 bytes _docs/images/IOOS_Emblem_Tertiary_A_RGB.jpg | Bin 0 -> 130289 bytes .../IOOS_Emblem_Tertiary_A_RGB_small.png | Bin 0 -> 14012 bytes _docs/index.md | 43 +++ debug.sh | 2 + search.json | 51 +++ 27 files changed, 967 insertions(+) create mode 100644 .devcontainer/Dockerfile create mode 100644 .devcontainer/devcontainer.json create mode 100644 .gitattributes create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/sync_theme.yml create mode 100644 .gitignore create mode 100644 .gitmodules create mode 100644 Gemfile create mode 100644 README.md create mode 100644 _config.yml create mode 100644 _config_dev.yml create mode 100644 _data/alerts.yml create mode 100644 _data/definitions.yml create mode 100644 _data/glossary.yml create mode 100644 _data/samplelist.yml create mode 100644 _data/sidebars/sidebar_ioos.yml create mode 100644 _data/strings.yml create mode 100644 _data/tags.yml create mode 100644 _data/terms.yml create mode 100644 _docs/howto.md create mode 100644 _docs/images/IOOS_Emblem_Primary_B_RGB.jpg create mode 100644 _docs/images/IOOS_Emblem_Primary_B_RGB_small.png create mode 100644 _docs/images/IOOS_Emblem_Tertiary_A_RGB.jpg create mode 100644 _docs/images/IOOS_Emblem_Tertiary_A_RGB_small.png create mode 100644 _docs/index.md create mode 100644 debug.sh create mode 100644 search.json diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile new file mode 100644 index 0000000..b7d03ef --- /dev/null +++ b/.devcontainer/Dockerfile @@ -0,0 +1,7 @@ +FROM infrastructurebuilder/ansible-container:latest +ENV HOME "/root" +ENV PATH "${HOME}/.local/bin:${PATH}" +RUN <= 0.1.0' if Gem.win_platform? + diff --git a/README.md b/README.md new file mode 100644 index 0000000..407b845 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# Cloud-Sandbox + +A template/skeleton repository that can be used as a starting point to create a new IOOS GitHub Documentation Site for deployment to https://ioos.github.io/. + +### Getting Started + +See online documentation for working with this repository at: https://ioos.github.io/Cloud-Sandbox/howto.html + +# IOOS Documentation Site: IOOS Cloud Sandbox + +**Site URL:** https://ioos.github.io/Cloud-Sandbox + + + +### Deploying site locally +Requirements: +* Ruby +* bundle +* Jekyll + +Clone this repository: +```commandline +git clone https://github.com/ioos/Cloud-Sandbox.git +``` +Rename the resulting `Cloud-Sandbox` directory to a name of your choice, and follow further [Getting Started](https://ioos.github.io/Cloud-Sandbox/howto.html#getting-started) section in the HOWTO documentation. + +To build the site, in your local renamed repo directory, run: +```commandline +bundle exec jekyll serve --config _config.yml --watch --verbose --incremental +``` +This will deploy a website at: http://127.0.0.1:4000/Cloud-Sandbox/. + +Further instructions for modifying and configuring your site can be found in the [Editing and configuring your documentation site](https://ioos.github.io/Cloud-Sandbox/howto.html#editing-and-configuring-your-documentation-site) section of the HOWTO. + +#### Editing site content + +Make edits to the appropriate markdown files in `_docs/`. + +If changing headers and menus, stop the running server by entering `ctrl-c` in the terminal. Then run: +```commandline +bundle exec jekyll clean +``` +Then build the site again. +```commandline +bundle exec jekyll serve --config _config.yml --watch --verbose --incremental +``` +And review at http://127.0.0.1:4000/Cloud-Sandbox/ + +More settings changes, including renaming the site URL to match your new repository name (replacing 'Cloud-Sandbox', should be made by editing the `_config.yml` and `_config_dev.yml` files in the repository root. See the [Edit Your Site Content](https://ioos.github.io/Cloud-Sandbox/howto.html#step-2-edit-your-documentation-site-content) section of the the HOWTO. \ No newline at end of file diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..ce561e0 --- /dev/null +++ b/_config.yml @@ -0,0 +1,160 @@ +output: web +# this property is useful for conditional filtering of content that is separate from the PDF. + +##### IOOS edit: replace this field with the documentation site name to appear on the top navigation bar next to the home button ##### +topnav_title: IOOS Cloud Sandbox Documentation + +site_title: IOOS Cloud Sandbox Documentation +# this appears in the html browser tab for the site title (seen mostly by search engines, not users) + +company_name: US IOOS +# this appears in the footer + +host: 127.0.0.1 +# the preview server used. Leave as is. + +port: 4000 +# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006. + +# Reading Files +include: + - .htaccess + #- _pages +exclude: + - .idea/ + - .devcontainer/ + - *.sh + - .gitignore + - Gemfile* + - theme/pages + #- theme/posts + - theme/Dockerfile + - theme/Gemfile + - theme/Gemfile.lock + - theme/search.json + - theme/update.sh + - theme/pdf-* + #- theme/ + + +##### IOOS edit: replace this field with the documentation site name to be included in feedback email subject line ##### +feedback_subject_line: IOOS Cloud Sandbox Documentation Feedback + +##### IOOS edit: replace this field with the contact email to submit to via the feedback link ##### +feedback_email: data.ioos@noaa.gov + + +# feedback_disable: true +# if you uncomment the previous line, the Feedback link gets removed + +# feedback_text: "Need help?" +# if you uncomment the previous line, it changes the Feedback text + +# feedback_link: "http://helpy.io/" +# if you uncomment the previous line, it changes where the feedback link points to + +highlighter: rouge +# library used for syntax highlighting + +markdown: kramdown +kramdown: + input: GFM + auto_ids: true + hard_wrap: false + syntax_highlighter: rouge + +# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways + +collections: + tooltips: + output: false + docs: + output: true + # using /docs/:name causes many link/path failures in hard-coded paths or values + # written into the templates (search, nav menu, etc). Instead just output :name + #permalink: /docs/:name + permalink: :name:output_ext + +# collections are declared here. this renders the content in _tooltips and processes it, but doesn't output it as actual files in the output unless you change output to true + +defaults: + - + scope: + path: "" + type: "pages" + values: + layout: "page" + comments: true + search: true + sidebar: sidebar_ioos + topnav: topnav_ioos + - + scope: + path: "" + type: "docs" + values: + layout: "page" + comments: true + search: true + sidebar: sidebar_ioos + topnav: topnav_ioos + + - + scope: + path: "" + type: "tooltips" + values: + layout: "page" + comments: true + search: true + tooltip: true + + - + scope: + path: "" + type: "posts" + values: + layout: "post" + comments: true + search: true + sidebar: sidebar_ioos + topnav: topnav_ioos + +# these are defaults used for the frontmatter for these file types + +sidebars: +- sidebar_ioos + +description: "A Jekyll-based documentation theme for data management documentation, software and other technical documentation needs. This is a skeleton repository for IOOS technical documentation projects to use as a starting point to develop new pages for the https://ioos.github.io site." +# the description is used in the feed.xml file + +#disqus_shortname: idrbwjekyll +# if you're using disqus for comments, add the shortname here. if not, leave this value blank. + + +################################################################################################################ +# IOOS EDIT HERE! Added settings for IOOS (replace 'Cloud-Sandbox' with your GitHub repo name):# +################################################################################################################ +# url/baseurl: modify baseurl so that url + baseurl combine to point to the full GitHub repo URL the site will be served from (replace 'your-documentation-repo-name') +# repository: modify to point to the GitHub repo shorthand name (replace 'your-documentation-repo-name') +# github_editme_path: provide the basepath to the branch containing source files for this site (replace 'your-documentation-repo-name'). 'blob/gh-pages/_docs' is standard and should remain as is + +url : "https://ioos.github.io" + +#baseurl : "/your-documentation-repo-name" +baseurl : "/Cloud-Sandbox" + +#repository : "ioos/your-documentation-repo-name" +repository : "ioos/Cloud-Sandbox" + +#github_editme_path : "ioos/your-documentation-repo-name/blob/gh-pages/_docs" +github_editme_path : "ioos/Cloud-Sandbox/blob/gh-pages/_docs" + + +#Setup/config for 'ioos_documentation_theme_jekyll' git submodule (do not alter): +source : . +destination : _site +plugins_dir : theme/_plugins +layouts_dir : theme/_layouts +data_dir : _data +includes_dir : theme/_includes diff --git a/_config_dev.yml b/_config_dev.yml new file mode 100644 index 0000000..95518f5 --- /dev/null +++ b/_config_dev.yml @@ -0,0 +1,12 @@ +# Welcome to Jekyll! +# +# This config file is meant for settings that affect your entire site, values +# which you are expected to set up once and rarely need to edit after that. +# For technical reasons, this file is *NOT* reloaded automatically when you use +# `jekyll serve`. If you change this file, please restart the server process. + +# Site Settings: only include setting for development on 'localhost' to override +# GitHub settings: + +url : "http://localhost:4000" +baseurl : "/ioos-documentation-jekyll-skeleton" diff --git a/_data/alerts.yml b/_data/alerts.yml new file mode 100644 index 0000000..157e162 --- /dev/null +++ b/_data/alerts.yml @@ -0,0 +1,15 @@ +tip: '