Skip to content
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

cp gh-pages branch to website/ #4011

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 3 additions & 0 deletions website/.circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
version: 2.1
jobs: {}
workflows: {}
49 changes: 49 additions & 0 deletions website/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# GH Pages
# _site is where local development puts built files
_site
# Gemfile.lock may vary based on local ruby version; best to not commit
Gemfile.lock

.vscode
.idea
.kube

# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib
bin/

# Test binary, built with `go test -c`
*.test

# Output of the go coverage tool, specifically when used with LiteIDE
*.out

# Dependency directories (remove the comment below to include it)
# vendor/

# .net core
*.suo
*.user
*.userosscache
*.sln.docstates
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
bld/
[Bb]in/
[Oo]bj/
[Oo]ut/
msbuild.log
msbuild.err
msbuild.wrn
packages

# macOS
.DS_Store
14 changes: 14 additions & 0 deletions website/.mergify.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
pull_request_rules:
- name: Require approval from Armada maintainers
conditions:
- "#approved-reviews-by>=1"
actions:
post_check:
success_conditions:
- or:
- "#approved-reviews-by>=2"
- and:
- "#approved-reviews-by>=1"
- "author~=^(JamesMurkin|severinson|d80tb7|carlocamurri|dejanzele|Sharpz7|ClifHouck|robertdavidsmith|theAntiYeti|richscott|suprjinx|zuqq)"
title:
Two are checks required.
18 changes: 18 additions & 0 deletions website/404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: default
description: Sorry – the page your looking for doesn't exist.
permalink: /404.html
---

<div class="page-header error-page fullWidth">
<div class="page-header-image" style="background-image: url('{{ '/assets/img/ill/404.svg' | relative_url }}')"></div>
<div class="container">
<div class="row">
<div class="col-md-12 text-center">
<h1 class="title">404</h1>
<p class="lead">Page not found :(</p>
<h4 class="description text-default">Ooooups! Looks like you got lost.</h4>
</div>
</div>
</div>
</div>
10 changes: 10 additions & 0 deletions website/500.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
layout: default
description: Sorry – the page your looking for doesn't exist.
permalink: /500.html
---
<div class="error-page">
<div class="page-header page-500 fullWidth">
<div class="page-header-image" style="background-image: url('{{ '/assets/img/ill/500.svg' | relative_url }}')"></div>
</div>
</div>
1 change: 1 addition & 0 deletions website/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
armadaproject.io
23 changes: 23 additions & 0 deletions website/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
source "https://rubygems.org"

# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
gem "github-pages", "~> 226", group: :jekyll_plugins
# If you have any plugins, put them here!
group :jekyll_plugins do
gem 'jekyll-paginate', "~> 1.1.0"
gem 'jekyll-sitemap', "~> 1.4.0"
end

# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library.
platforms :mingw, :x64_mingw, :mswin, :jruby do
gem "tzinfo", "~> 1.2"
gem "tzinfo-data"
end

# Performance-booster for watching directories on Windows
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]

# Requiring this version of webrick permits this to work under ruby 3.x.
gem "webrick", "~> 1.7"
80 changes: 80 additions & 0 deletions website/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
This branch is the github pages repo for armadaproject.io. This document
contains tips and conventions about how to develop the website interactively.


Conventions
-----------

Integration with master branch
==============================
The Armada master branch contains github workflows that will copy over some
files when committed to that branch. Ensure no changes you are making here
will be overwritten on the next master push, and make changes in the master
branch when appropriate.

Interesting Files/Directories
=============================
- All markdown files in the root of the branch are rendered as webpages, by
default at the path `/blah` for a given file `blah.md` (but this behavior
can be overridden by jekyll headers).
- `_pages/` is the pages collection, as defined in `_config.yml` -- generally
speaking, it's best to leave the markdown files in the root directory
instead unless you have a specific reason.
- `_layouts/` contains layouts which can be used to format markdown files.
- `default.html` is the default layout, used by almost all pages.
- `redirect.html` is a layout designed to 301 redirect based on headers.
- `_includes/` includes various files included to build the page. such as
headers, footers, and similar.
- `_data/settings.yml` is an additional settings file, which contains the
tree used to render the navigation bar.


Testing
-------
armadaproject.io is a jekyll generated site, using github pages. You have two
choices for running it locally for testing.

Local testing with Docker
========================

Using Docker is the simplest way to render the site and preview locally:

- run `docker run -p 4000:4000 -v $(pwd):/site bretfisher/jekyll-serve`
- navigate to `http://localhost:4000`

Local testing (native)
======================

The below is a summary of how to test locally. The canonical documentation
for doing this is in Github docs:
https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.

Prerequisites
^^^^^^^^^^^^^
- Ensure you have ruby and bundler available.
- Access to a rubygem repository.

Initial configuration
^^^^^^^^^^^^^^^^^^^^^
- Run `bundle install` from the root of this repository.
- Run `bundle exec jekyll serve` to serve the website locally (defaults to
127.0.0.1:4000). This will update as files served beneath it update.

Notes/Maintenance
^^^^^^^^^^^^^^^^^
It's neccessary from time to time to upgrade the github-pages gem in the
bundle. The latest github-pages gem is always used to render by github,
so we should always test with the latest when possible.

- `bundle update github-pages`
- Commit the resulting updates to `Gemfile`, if needed.

Note: Never commit `Gemfile.lock`. The specific versions of gems used may
vary by platform. The important part is that we're installing the gems via
github-pages.

Testing via github
==================
If you push the contents of gh-pages branch to your fork's gh-pages branch,
the page will be published at the following URL:
https://{ghusername}.github.io/armada.
42 changes: 42 additions & 0 deletions website/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
site: Armada

url: "https://armadaproject.io"
baseurl: ""

collections:
pages:
output: true
permalink: /:name

defaults:
-
scope:
path: ""
values:
layout: "default"
-
scope:
path: ""
type: "pages"
values:
layout: "default"
-
scope:
path: ""
type: "posts"
values:
layout: "post"

sass:
sass_dir: assets/styles
style: compressed
sourcemap: never

plugins:
- jekyll-paginate
- jekyll-sitemap

paginate: 6
paginate_path: "/blog/page:num/"
exclude: ["internal"]

77 changes: 77 additions & 0 deletions website/_data/settings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
basic_settings:
site_title: Armada Project
favicon_image: /assets/img/Armada-favicon.png

header_settings:
logo_image: /assets/img/brand/Armada-white-rectangle.png
mobile_logo_image: /assets/img/brand/Armada-dark-rectangle.png
# Choose a color for your header [blue, dark, light].
theme: dark
# If the page has a featured image, it turns transparent if allow_transparent is set to "yes".
allow_transparent: "yes"

home_settings:
# Choose a layout for your home page:
# landing – an example landing page made using the Argon design system
# blog – use your blog posts as the home page
theme: landing

blog_settings:
# Choose a format for your blog listings:
# basic – a simple list of posts
# narrow – a masonary grid of posts
# grid – a full-width square grid of posts
theme: narrow
# Should we display a narrow grid of other posts at the bottom of each blog post?
read_more: "yes"

# Setup your navigation below – how to use the icons:
# 1. See all the icons available here https://demos.creative-tim.com/argon-design-system-pro/docs/1.0/foundation/icons.html
# 2. Get the name of the icon e.g basket, then prefix with ni to make ni-basket.
# 3. Add a color of the icon - text-primary, text-success, text-info, text-danger, text-warning and text-default all work!
menu_settings:
menu_items:
- title: 'Design'
url: '/design/'
- title: 'Documentation'
submenu_items:
- title: 'Quickstart'
url: '/quickstart'
- title: 'User Guide'
url: '/user'
- title: 'Libraries'
url: '/libraries'
- title: 'Contribute'
url: '/contribute'

footer_settings:
footer_tagline: Armada Project

contact_settings:
form_action: 'https://formspree.io/[email protected]'
confirmation_url: '/thanks'
email_subject: 'Contact form submission'
send_button_text: 'Send Message'

social_settings:
facebook_url: ''
discussions_url: 'https://github.com/armadaproject/armada/discussions'
twitter_url: 'https://twitter.com/oss_gr'
instagram_url: ''
youtube_url: ''
vimeo_url: ''
pinterest_url: ''
gitter_url: ''
dribbble_url: ''
behance_url: ''
github_url: 'https://github.com/armadaproject/armada'
reddit_url: ''
linkedin_url: ''
slack_url: 'https://cloud-native.slack.com/archives/C03T9CBCEMC'

authors:

advanced_settings:
analytics_code: 'G-SKPDW30VNF'
header_js:
footer_js:
Loading
Loading