Skip to content

Commit

Permalink
Initial (and incomplete) commit
Browse files Browse the repository at this point in the history
  • Loading branch information
mykelalvis committed Nov 15, 2024
0 parents commit f057e63
Show file tree
Hide file tree
Showing 27 changed files with 967 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
FROM infrastructurebuilder/ansible-container:latest
ENV HOME "/root"
ENV PATH "${HOME}/.local/bin:${PATH}"
RUN <<SCRIPT1
dnf -y update
dnf install -y libffi-devel ruby-devel gcc-c++ make
SCRIPT1
5 changes: 5 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"build": {
"dockerfile": "Dockerfile"
}
}
5 changes: 5 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
_assets/css/vendor/* linguist-vendored
_assets/js/plugins/* linguist-vendored
_assets/js/vendor/* linguist-vendored
assets/fonts/* linguist-vendored
assets/js/vendor/* linguist-vendored
15 changes: 15 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# See https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot

version: 2
updates:

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
labels:
- "Bot"
groups:
github-actions:
patterns:
- '*'
52 changes: 52 additions & 0 deletions .github/workflows/sync_theme.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: sync theme submodules

on:
push:
branches: gh-pages

schedule:
- cron: "00 14 * * *"

workflow_dispatch:


jobs:
sync_theme_submodules:
if: github.repository_owner == 'ioos' # only run if ioos owns repo
runs-on: ubuntu-20.04
steps:
- name: Checkout repo
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4

- name: submodule checkout
run: |
git submodule update --init
- name: check submodule status
run: |
git submodule status
- name: Update theme from submodules
run: |
git submodule update --remote --merge
- name: check submodule status 2
run: |
git submodule status
- name: Commit and push if it changed
run: |
git config user.name "Automated"
git config user.email "actions@users.noreply.github.com"
git add -A
timestamp=$(date -u)
git commit -m "Update theme on: ${timestamp}" || exit 0
git push
keepalive-job:
name: Keepalive Workflow
runs-on: ubuntu-latest
if: github.event_name == 'schedule'
permissions:
actions: write
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
- uses: gautamkrishnar/keepalive-workflow@3eb47f21355191080dca0f7662d45c192d2ef64d # 2.0.7
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
_site/
.sass-cache/
.jekyll-metadata
.ipynb_checkpoints
_pdf
.idea/
.DS_Store
temp
Gemfile.lock
7 changes: 7 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[submodule "documentation-theme-jekyll"]
path = theme
url = https://github.com/ioos/documentation-theme-jekyll
[submodule "_data/navbars_theme"]
path = _data/navbars
url = https://github.com/ioos/documentation-theme-jekyll
branch = navbars
5 changes: 5 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
source "https://rubygems.org"

gem 'github-pages', group: :jekyll_plugins
gem 'wdm', '>= 0.1.0' if Gem.win_platform?

49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
160 changes: 160 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -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
12 changes: 12 additions & 0 deletions _config_dev.yml
Original file line number Diff line number Diff line change
@@ -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"
15 changes: 15 additions & 0 deletions _data/alerts.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
tip: '<div class="alert alert-success" role="alert"><i class="fa fa-check-square-o"></i> <b>Tip: </b>'
note: '<div class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note: </b>'
important: '<div class="alert alert-warning" role="alert"><i class="fa fa-warning"></i> <b>Important: </b>'
warning: '<div class="alert alert-danger" role="alert"><i class="fa fa-exclamation-circle"></i> <b>Warning: </b>'
end: '</div>'

callout_danger: '<div class="bs-callout bs-callout-danger">'
callout_default: '<div class="bs-callout bs-callout-default">'
callout_primary: '<div class="bs-callout bs-callout-primary">'
callout_success: '<div class="bs-callout bs-callout-success">'
callout_info: '<div class="bs-callout bs-callout-info">'
callout_warning: '<div class="bs-callout bs-callout-warning">'

hr_faded: '<hr class="faded"/>'
hr_shaded: '<hr class="shaded"/>'
9 changes: 9 additions & 0 deletions _data/definitions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
elephant: "This is a sample definition."

baseball: "Baseball is considered America's pasttime sport, though that may be more of a historical term than a current one. There's a lot more excitement about football than baseball. A baseball game is somewhat of a snooze to watch, for the most part."

basketball: "Basketball is a sport involving two teams of five players each competing to put a ball through a small circular rim 10 feet above the ground. Basketball requires players to be in top physical condition, since they spend most of the game running back and forth along a 94-foot-long floor."

football: "No doubt the most fun sport to watch, football also manages to accrue the most injuries with the players. From concussions to blown knees, football players have short sport lives."

soccer: "If there's one sport that dominates the world landscape, it's soccer. However, US soccer fans are few and far between. Apart from the popularity of soccer during the World Cup, most people don't even know the name of the professional soccer organization in their area."
11 changes: 11 additions & 0 deletions _data/glossary.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
jekyll_platform: "Jekyll is a static site generator that builds sites using most modern web technologies."

fractious: "Like a little mischevious child, full of annoying and constant trouble."

gratuitous: "Something that is unwarranted and uncouth, like the social equivalent of a flagrant foul."

haughty: "Proud and flaunting it. Holding your head high up like a snooty, too-good-for-everything rich person."

impertinent: "Someone acting rude and insensitive to others."

intrepid: "Brave and courageous especially in a difficult, dangerous situation."
Loading

0 comments on commit f057e63

Please sign in to comment.