Skip to content

Commit

Permalink
[docs] Made some more progress with docs. Set up auto deploy and mini…
Browse files Browse the repository at this point in the history
…fied

current public build.

Signed-off by: Kendall Tauser <[email protected]>
  • Loading branch information
fire833 committed Aug 20, 2022
1 parent 495d80b commit fe78806
Show file tree
Hide file tree
Showing 11 changed files with 122 additions and 736 deletions.
51 changes: 51 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@

# Copyright (C) 2022 Kendall Tauser
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

name: Build docs

on:
push:
branches:
- main # Set a branch to deploy

pull_request:

jobs:
deploy:
runs-on: ubuntu-20.04
steps:

- uses: actions/checkout@v2
with:
# submodules: true # Fetch Hugo themes (true OR recursive)
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: 'latest'
# extended: true

- name: Build
run: hugo --minify

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs
17 changes: 17 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@

# Copyright (C) 2022 Kendall Tauser
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

name: unit-test

on:
Expand Down
6 changes: 6 additions & 0 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

---
Title: morfic
---

# morfic
66 changes: 2 additions & 64 deletions docs/public/404.html
Original file line number Diff line number Diff line change
@@ -1,64 +1,2 @@

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
<meta name="generator" content="Hugo 0.101.0">
<meta name="generator" content="Relearn 5.2.1+tip">
<meta name="description" content="">
<title>404 Page not found :: Documentation for the morfic Kubernetes-Native Network manager</title>
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
<link href="/css/fontawesome-all.min.css?1660968800" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fontawesome-all.min.css?1660968800" rel="stylesheet"></noscript>
<link href="/css/featherlight.min.css?1660968800" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/featherlight.min.css?1660968800" rel="stylesheet"></noscript>
<link href="/css/auto-complete.css?1660968800" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/auto-complete.css?1660968800" rel="stylesheet"></noscript>
<link href="/css/perfect-scrollbar.min.css?1660968800" rel="stylesheet">
<link href="/css/nucleus.css?1660968800" rel="stylesheet">
<link href="/css/fonts.css?1660968800" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fonts.css?1660968800" rel="stylesheet"></noscript>
<link href="/css/theme.css?1660968800" rel="stylesheet">
<link href="/css/theme-relearn-light.css?1660968800" rel="stylesheet" id="variant-style">
<link href="/css/ie.css?1660968800" rel="stylesheet">
<link href="/css/variant.css?1660968800" rel="stylesheet">
<link href="/css/print.css?1660968800" rel="stylesheet" media="print">
<script src="/js/variant.js?1660968800"></script>
<script>
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
var index_url="/index.json";
var root_url="/";
var baseUri=root_url.replace(/\/$/, '');
// translations
window.T_Copy_to_clipboard = 'Copy to clipboard';
window.T_Copied_to_clipboard = 'Copied to clipboard!';
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
// some further base stuff
var baseUriFull='https:\/\/morfic.io/';
window.variants && variants.init( [ 'relearn-light' ] );
</script>
<script src="/js/jquery.min.js?1660968800" defer></script>
<style>
p, li, ul {
text-align: center
}
ul {
list-style-type: none;
}
</style>
</head>
<body class="mobile-support" data-url="/">
<div id="body" class="default-animation" style="margin-left:0px;">
<div id="sidebar-overlay"></div>
<main id="body-inner" class="chapter" tabindex="-1">
<div class="flex-block-wrapper">
<h1>Error</h1>
<p></p>
<p>Woops. Looks like this page doesn&#39;t exist ¯\_(ツ)_/¯.</p>
<p></p>
<p><a href="/">Go to homepage</a></p>
<p><img src="/images/gopher-404.jpg" style="width:50%" alt="Page not found!"></p>
</div>
</main>
</div>
</body>
</html>
<!doctype html><html lang=en><head><meta charset=utf-8><meta name=viewport content="height=device-height,width=device-width,initial-scale=1,minimum-scale=1"><meta name=generator content="Hugo 0.101.0"><meta name=generator content="Relearn 5.2.1+tip"><meta name=description content><title>404 Page not found :: Documentation for morfic, the Kubernetes-Native Network manager</title><link href=/css/fontawesome-all.min.css?1661035442 rel=stylesheet media=print onload='this.media="all",this.onload=null'><noscript><link href=/css/fontawesome-all.min.css?1661035442 rel=stylesheet></noscript><link href=/css/featherlight.min.css?1661035442 rel=stylesheet media=print onload='this.media="all",this.onload=null'><noscript><link href=/css/featherlight.min.css?1661035442 rel=stylesheet></noscript><link href=/css/auto-complete.css?1661035442 rel=stylesheet media=print onload='this.media="all",this.onload=null'><noscript><link href=/css/auto-complete.css?1661035442 rel=stylesheet></noscript><link href=/css/perfect-scrollbar.min.css?1661035442 rel=stylesheet><link href=/css/nucleus.css?1661035442 rel=stylesheet><link href=/css/fonts.css?1661035442 rel=stylesheet media=print onload='this.media="all",this.onload=null'><noscript><link href=/css/fonts.css?1661035442 rel=stylesheet></noscript><link href=/css/theme.css?1661035442 rel=stylesheet><link href=/css/theme-relearn-light.css?1661035442 rel=stylesheet id=variant-style><link href=/css/ie.css?1661035442 rel=stylesheet><link href=/css/variant.css?1661035442 rel=stylesheet><link href=/css/print.css?1661035442 rel=stylesheet media=print><script src=/js/variant.js?1661035442></script>
<script>var index_url="/index.json",baseUriFull,root_url="/",baseUri=root_url.replace(/\/$/,"");window.T_Copy_to_clipboard="Copy to clipboard",window.T_Copied_to_clipboard="Copied to clipboard!",window.T_Copy_link_to_clipboard="Copy link to clipboard",window.T_Link_copied_to_clipboard="Copied link to clipboard!",baseUriFull="https://morfic.io/",window.variants&&variants.init(["relearn-light"])</script><script src=/js/jquery.min.js?1661035442 defer></script><style>p,li,ul{text-align:center}ul{list-style-type:none}</style></head><body class=mobile-support data-url=/><div id=body class=default-animation style=margin-left:0><div id=sidebar-overlay></div><main id=body-inner class=chapter tabindex=-1><div class=flex-block-wrapper><h1>Error</h1><p></p><p>Woops. Looks like this page doesn't exist ¯\_(ツ)_/¯.</p><p></p><p><a href=/>Go to homepage</a></p><p><img src=/images/gopher-404.jpg style=width:50% alt="Page not found!"></p></div></main></div></body></html>
Loading

0 comments on commit fe78806

Please sign in to comment.