ForgeFlux/docs
2
0
Fork 0
Code Issues 1 Pull requests 2 Projects Releases Packages Wiki Activity

Updated changelogs

Browse source
This commit is contained in:
dat-adi 2022-01-09 16:16:38 +05:30
parent 47031e8ecc
commit 49b4c484b8
19 changed files with 1984 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
.github/workflows/publish.yml vendored
View file

@ -4,32 +4,29 @@ on: push
jobs:
build:
name: x86_64-unknown-linux-gnu
runs-on: ubuntu-latest
if: github.ref != 'refs/heads/main'
steps:
- name: 'checkout'
uses: actions/checkout@v2
runs-on: ubuntu-18.04
- name: 'build'
uses: shalzz/zola-deploy-action@v0.13.0
env:
PAGES_BRANCH: gh-pages
BUILD_DIR: ./docs/zola
TOKEN: ${{ secrets.TOKEN }}
build_and_deploy:
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
steps:
- name: Display the path
run: pwd
shell: bash
- name: 'checkout'
uses: actions/checkout@v2
- name: 'build and deploy'
uses: shalzz/zola-deploy-action@v0.13.0
env:
PAGES_BRANCH: docs
BUILD_DIR: ./docs/zola
TOKEN: ${{ secrets.PUBLIC_TOKEN }}
REPOSITORY: dat-adi/ff-zola
- uses: actions/checkout@v2
with:
submodules: true
fetch-depth: 0
- name: Install Zola
run: ./scripts/ci.sh install
- name: Build production website
run: ./scripts/ci.sh build
- name: Deploy to gh-pages 🚀
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
uses: JamesIves/github-pages-deploy-action@4.1.4
with:
branch: gh-pages
token: ${{ secrets.GITHUB_TOKEN }}
folder: ./public
- name: deploy
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' && github.repository == 'forgeflux-org/docs' }}
run: >-
curl --location --request POST "https://deploy.batsense.net/api/v1/update" --header 'Content-Type: application/json' --data-raw "{ \"secret\": \"${{ secrets.DEPLOY_TOKEN }}\", \"branch\": \"gh-pages\" }"

11
docs/zola/content/solder/november2020.md Normal file
View file

@ -0,0 +1,11 @@
+++
title = "November 2020"
weight = 40
+++
# November 2020
Errors were modularized at the back of [Northstar](https://github.com/forgeflux-org/northstar/).
A Docker CI was set up for the Northstar builds.
A [GitHub organization](https://github.com/forgeflux-org) was created for ForgeFedv2, and the repositories for the projects were
transferred over to it.

29
docs/zola/content/solder/october2020.md Normal file
View file

@ -0,0 +1,29 @@
+++
title = "October 2020"
weight = 40
+++
# October 2020
In the month of October, there were significant changes to the development in ForgeFedv2.
Starting off with the addition of the [OpenAPI Specification](https://forgeflux-org.github.io/northstar/) for Northstar.
## Northstar
A database model was created to store the details of the various forge interfaces,
having these details would be a prerequisite to looking up a server.
Endpoints were subsequently created, following the defined OpenAPI specification.
While the Lookup service was in the process of development, terminologies and the
concept for Forge Federation was also being [discussed](https://github.com/forgeflux-org/spec/tree/master/rfc).
Docker support as part of the CI process was added into the mix.
Keeping in mind, that the test suite was the method to work with the application for
the time being, an initial working model for the lookup service was established.
## Interface
Development of the `libgit` library had begun.
[libgit] is a library that processes the contributor's changes, and generates a patch.
Details regarding the implementation and feature set of libgit will be covered in another section.
## References
- Database Initialization :: [database init](https://github.com/forgeflux-org/northstar/commit/6a82a1bc83d4733a5a077e33ad0c222aed496145)

3
docs/zola/public/404.html Normal file
View file

@ -0,0 +1,3 @@
<!doctype html>
<title>404 Not Found</title>
<h1>404 Not Found</h1>

43
docs/zola/public/getting-started/index.html Normal file
View file

@ -0,0 +1,43 @@
<html>
<head>
<title>Zola</title>
</head>
<body>
<div class="container">
<h1>Welcome to Zola!</h1>
<p>
You're seeing this page because we couldn't find a template to render.
</p>
<p>
To modify this page, create a <b>section.html</b> file in the templates directory or
<a href="https://www.getzola.org/documentation/themes/installing-and-using-themes/" target="_blank">install a theme</a>.
<br>
You can find what variables are available in this template in the <a href="https:&#x2F;&#x2F;www.getzola.org&#x2F;documentation&#x2F;templates&#x2F;pages-sections&#x2F;#section-variables" target="_blank">documentation</a>.
</p>
</div>
<footer>
<a href="https://www.getzola.org/documentation/getting-started/cli-usage/" target="_blank">Get started with Zola</a>
</footer>
<style>
html {
line-height: 1.5;
}
h1 {
margin-bottom: 2rem;
}
.container {
font-family: "sans-serif";
text-align: center;
margin-top: 20vh;
padding: 2rem;
background: #e9e9e9;
}
footer {
position: fixed;
width: 100%;
bottom: 1rem;
text-align: center;
}
</style>
</body>
</html>

203
docs/zola/public/getting-started/intro/index.html Normal file
View file

@ -0,0 +1,203 @@
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="https://dat-adi.github.io/ff-zola/main.css">
<link rel="icon" href="https://www.getzola.org/favicon.ico">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
<title> Docs | How does it work? </title>
</head>
<body>
<script>
fetch('https://api.github.com/repos/getzola/zola/releases/latest')
.then((response) => {
return response.json();
})
.then((data) => {
let release_name = data.name;
let html_url = data.html_url;
release.innerHTML = `<a href='${html_url}'>${release_name}</a>`;
});
</script>
<main>
<nav>
<a href="https:&#x2F;&#x2F;dat-adi.github.io&#x2F;ff-zola&#x2F;">
<img src="https://easydocs.codeandmedia.com/logo.svg" alt="" />
</a>
<div id="release"></div>
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
<div id="trees">
<input class="tree-toggle" type="checkbox" id="services"
/>
<label class="tree-toggle-label" for="services">Services</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/services/interface/">Interface</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/services/northstar/">Northstar</a>
</li>
</ul>
<input class="tree-toggle" type="checkbox" id="getting-started"
checked />
<label class="tree-toggle-label" for="getting-started">Getting Started</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/getting-started/services/">Services</a>
</li>
<li class="active">
<a href="https://dat-adi.github.io/ff-zola/getting-started/intro/">How does it work?</a>
</li>
</ul>
<input class="tree-toggle" type="checkbox" id="solder"
/>
<label class="tree-toggle-label" for="solder">Solder</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/november2020/">November 2020</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/october2020/">October 2020</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/september2020/">September 2020</a>
</li>
</ul>
</div>
</nav>
<article>
<div id="on_right">
<span id="search-ico" class="ms-Icon--Search"></span>
</div>
<div class="search-container">
<input id="search" type="search" placeholder="Search as you type...">
<div class="search-results">
<div class="search-results__header"></div>
<ul class="search-results__items"></ul>
</div>
</div>
<div id="wrap">
<h1 id="how-does-it-work">How does it work?</h1>
<p>Interfaces are services that are run on the side of any user, and are used as connecting points of the bridge.
These interfaces are responsible for communicating with each other, and interact in the form of messages for a server-server model, and a REST API model for the server-user model.</p>
<p>Interfaces are geared towards performing various operations for the repository, which include but are not limited to,</p>
<ul>
<li>Pull Requests</li>
<li>Issues</li>
<li>Comments</li>
<li>Notifications</li>
<li>Forking</li>
</ul>
<p>However, as the count for interfaces go up in magnitudes, it becomes increasingly hard to keep track of them.
This is where Northstar comes to play, by implementing a lookup server that seeks to provide an indexed list of available forge interfaces.</p>
<p>ForgeFlux is currently in the Active Development phase, and is being worked on towards the alpha-testing stage.</p>
</div>
</article>
</main>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/elasticlunr.min.js" defer></script>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/search_index.en.js" defer></script>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/js.js" defer></script>
</body>
</html>

220
docs/zola/public/getting-started/services/index.html Normal file
View file

@ -0,0 +1,220 @@
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="https://dat-adi.github.io/ff-zola/main.css">
<link rel="icon" href="https://www.getzola.org/favicon.ico">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
<title> Docs | Services </title>
</head>
<body>
<script>
fetch('https://api.github.com/repos/getzola/zola/releases/latest')
.then((response) => {
return response.json();
})
.then((data) => {
let release_name = data.name;
let html_url = data.html_url;
release.innerHTML = `<a href='${html_url}'>${release_name}</a>`;
});
</script>
<main>
<nav>
<a href="https:&#x2F;&#x2F;dat-adi.github.io&#x2F;ff-zola&#x2F;">
<img src="https://easydocs.codeandmedia.com/logo.svg" alt="" />
</a>
<div id="release"></div>
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
<div id="trees">
<input class="tree-toggle" type="checkbox" id="services"
/>
<label class="tree-toggle-label" for="services">Services</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/services/interface/">Interface</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/services/northstar/">Northstar</a>
</li>
</ul>
<input class="tree-toggle" type="checkbox" id="getting-started"
checked />
<label class="tree-toggle-label" for="getting-started">Getting Started</label>
<ul class="subtree">
<li class="active">
<a href="https://dat-adi.github.io/ff-zola/getting-started/services/">Services</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/getting-started/intro/">How does it work?</a>
</li>
</ul>
<input class="tree-toggle" type="checkbox" id="solder"
/>
<label class="tree-toggle-label" for="solder">Solder</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/november2020/">November 2020</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/october2020/">October 2020</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/september2020/">September 2020</a>
</li>
</ul>
</div>
</nav>
<article>
<div id="on_right">
<span id="search-ico" class="ms-Icon--Search"></span>
</div>
<div class="search-container">
<input id="search" type="search" placeholder="Search as you type...">
<div class="search-results">
<div class="search-results__header"></div>
<ul class="search-results__items"></ul>
</div>
</div>
<div id="wrap">
<h1 id="services">Services</h1>
<p>The services that are currently in active development are Northstar, and Interface.
However, here's a few more details about them.</p>
<h2 id="northstar">Northstar</h2>
<ul>
<li>Repository :: <a href="https://github.com/forgeflux-org/northstar">Source Code</a></li>
<li>OpenAPI :: <a href="https://northstar.forgeflux.org/docs/openapi/">OpenAPI Specification</a></li>
</ul>
<p>ForgeFlux allows for multiple interfaces to be run against a single software forge.
Also, the protocol is flexible enough to support multiple types of software forges(GitLab, GitHub, etc).
The protocol's decentralised nature makes it impossible to create a constant record of which interfaces service forges.</p>
<p>So we created a discovery service which stores records of interfaces and the forges they service.
This is very similar to the way DNS works.
In DNS, hostname is resolved to IP address.</p>
<p>Here, software forge URL is resolved to URLs of <a href="https://github.com/forgeflux-org/interface">interfaces</a> that service the queried forge.</p>
<p>For an extensive view on Northstar, please check <a href="https://dat-adi.github.io/ff-zola/services/northstar/">Northstar::Detailed</a></p>
<h2 id="interface">Interface</h2>
<ul>
<li>Repository :: <a href="https://github.com/forgeflux-org/interface">Source Code</a></li>
<li>OpenAPI :: <a href="https://github.com/forgeflux-org/interface/tree/master/docs/openapi">OpenAPI Specification</a></li>
</ul>
<p>Developing Free Software is about liberating users and giving them total control over how the programs they run should work.
It's only fair that developers of such software enjoy the same levels of liberty.</p>
<p>ForgeFlux is an attempt to enable federation for major software forges (GitLab, GitHub, Gitea, Source Hut, etc) entirely in API-space.
We believe our API-space implementation will allow for more organic growth as it will not require any involvement from the forge developers.</p>
</div>
</article>
</main>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/elasticlunr.min.js" defer></script>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/search_index.en.js" defer></script>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/js.js" defer></script>
</body>
</html>

209
docs/zola/public/index.html Normal file
View file

@ -0,0 +1,209 @@
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="https://dat-adi.github.io/ff-zola/main.css">
<link rel="icon" href="https://www.getzola.org/favicon.ico">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
<title>Docs</title>
</head>
<body>
<script>
fetch('https://api.github.com/repos/getzola/zola/releases/latest')
.then((response) => {
return response.json();
})
.then((data) => {
let release_name = data.name;
let html_url = data.html_url;
release.innerHTML = `<a href='${html_url}'>${release_name}</a>`;
});
</script>
<main>
<nav>
<img src="https://easydocs.codeandmedia.com/logo.svg" alt="" />
<div id="release"></div>
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
<div id="trees">
<input class="tree-toggle" type="checkbox" id="services"
/>
<label class="tree-toggle-label" for="services">Services</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/services/interface/">Interface</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/services/northstar/">Northstar</a>
</li>
</ul>
<input class="tree-toggle" type="checkbox" id="getting-started"
/>
<label class="tree-toggle-label" for="getting-started">Getting Started</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/getting-started/services/">Services</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/getting-started/intro/">How does it work?</a>
</li>
</ul>
<input class="tree-toggle" type="checkbox" id="solder"
/>
<label class="tree-toggle-label" for="solder">Solder</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/november2020/">November 2020</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/october2020/">October 2020</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/september2020/">September 2020</a>
</li>
</ul>
</div>
</nav>
<article>
<div id="on_right">
<span id="search-ico" class="ms-Icon--Search"></span>
</div>
<div class="search-container">
<input id="search" type="search" placeholder="Search as you type...">
<div class="search-results">
<div class="search-results__header"></div>
<ul class="search-results__items"></ul>
</div>
</div>
<div id="wrap">
<h1 id="forgeflux">ForgeFlux&nbsp;<a class="anchor" href="#forgeflux">&#xE732;</a></h1>
<p><a href="https://forgeflux.org/">ForgeFlux</a> aims to implement federation in <a href="https://en.wikipedia.org/wiki/Forge_(software)">software forges</a> , enabling
a decentralized development environment.</p>
<h2 id="why-is-this-significant">Why is this significant?&nbsp;<a class="anchor" href="#why-is-this-significant">&#xE732;</a></h2>
<p>There have been numerous forges that have popped
up over the course of time.
Each of these forges have their own community base,
and projects that are associated to the forge itself.</p>
<p>However, issues arise when a user wishes to contribute towards
a project that exists in another forge.
This would require them to charter into unknown forge territory,
to have to relearn the functionality that they're already at home with.</p>
<p>ForgeFlux, is an idea, that intends to get rid this problem.
Work on your own forge, but <strong>bridge</strong> the project.</p>
<p>Bridging a project would allow for a user to contribute towards projects that
exist in foreign forges, through the comfort of their own forge.</p>
<h2 id="has-this-been-done-before">Has this been done before?&nbsp;<a class="anchor" href="#has-this-been-done-before">&#xE732;</a></h2>
<p>The initial <a href="https://forgefed.peers.community/">forgefed</a> was
an attempt to bridge this gap, by introducing the concept
of bridging the gap between forges.
This approach required for the forge developers to actively
participate in the development of the software.</p>
<p>The present ForgeFlux, focuses on the implementation being present
in the API space instead.
This reduces the interference required on the side of the forges themselves,
and seeks to develop on existing utility and APIs provided.</p>
<p>ForgeFlux, consists of a terminology for the development and
utilization of it's software, which result in terms such as <code>forges</code>,
and <code>interfaces</code> being tossed around.
It is recommended for a reader to go through the <a href="https://github.com/forgeflux-org/spec/blob/master/rfc/1-ecosystem-architecture/1-ecosystem-architecture.md">ecosystem-architecture</a>, if there is any confusion regarding the usage of particular words in this documentation.</p>
</div>
</article>
</main>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/elasticlunr.min.js" defer></script>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/search_index.en.js" defer></script>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/js.js" defer></script>
</body>
</html>

3
docs/zola/public/robots.txt Normal file
View file

@ -0,0 +1,3 @@
User-agent: *
Allow: /
Sitemap: https://dat-adi.github.io/ff-zola/sitemap.xml

2
docs/zola/public/search_index.en.js
View file

File diff suppressed because one or more lines are too long

43
docs/zola/public/services/index.html Normal file
View file

@ -0,0 +1,43 @@
<html>
<head>
<title>Zola</title>
</head>
<body>
<div class="container">
<h1>Welcome to Zola!</h1>
<p>
You're seeing this page because we couldn't find a template to render.
</p>
<p>
To modify this page, create a <b>section.html</b> file in the templates directory or
<a href="https://www.getzola.org/documentation/themes/installing-and-using-themes/" target="_blank">install a theme</a>.
<br>
You can find what variables are available in this template in the <a href="https:&#x2F;&#x2F;www.getzola.org&#x2F;documentation&#x2F;templates&#x2F;pages-sections&#x2F;#section-variables" target="_blank">documentation</a>.
</p>
</div>
<footer>
<a href="https://www.getzola.org/documentation/getting-started/cli-usage/" target="_blank">Get started with Zola</a>
</footer>
<style>
html {
line-height: 1.5;
}
h1 {
margin-bottom: 2rem;
}
.container {
font-family: "sans-serif";
text-align: center;
margin-top: 20vh;
padding: 2rem;
background: #e9e9e9;
}
footer {
position: fixed;
width: 100%;
bottom: 1rem;
text-align: center;
}
</style>
</body>
</html>

191
docs/zola/public/services/interface/index.html Normal file
View file

@ -0,0 +1,191 @@
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="https://dat-adi.github.io/ff-zola/main.css">
<link rel="icon" href="https://www.getzola.org/favicon.ico">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
<title> Docs | Interface </title>
</head>
<body>
<script>
fetch('https://api.github.com/repos/getzola/zola/releases/latest')
.then((response) => {
return response.json();
})
.then((data) => {
let release_name = data.name;
let html_url = data.html_url;
release.innerHTML = `<a href='${html_url}'>${release_name}</a>`;
});
</script>
<main>
<nav>
<a href="https:&#x2F;&#x2F;dat-adi.github.io&#x2F;ff-zola&#x2F;">
<img src="https://easydocs.codeandmedia.com/logo.svg" alt="" />
</a>
<div id="release"></div>
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
<div id="trees">
<input class="tree-toggle" type="checkbox" id="services"
checked />
<label class="tree-toggle-label" for="services">Services</label>
<ul class="subtree">
<li class="active">
<a href="https://dat-adi.github.io/ff-zola/services/interface/">Interface</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/services/northstar/">Northstar</a>
</li>
</ul>
<input class="tree-toggle" type="checkbox" id="getting-started"
/>
<label class="tree-toggle-label" for="getting-started">Getting Started</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/getting-started/services/">Services</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/getting-started/intro/">How does it work?</a>
</li>
</ul>
<input class="tree-toggle" type="checkbox" id="solder"
/>
<label class="tree-toggle-label" for="solder">Solder</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/november2020/">November 2020</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/october2020/">October 2020</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/september2020/">September 2020</a>
</li>
</ul>
</div>
</nav>
<article>
<div id="on_right">
<span id="search-ico" class="ms-Icon--Search"></span>
</div>
<div class="search-container">
<input id="search" type="search" placeholder="Search as you type...">
<div class="search-results">
<div class="search-results__header"></div>
<ul class="search-results__items"></ul>
</div>
</div>
<div id="wrap">
<h1 id="interface">Interface&nbsp;<a class="anchor" href="#interface">&#xE732;</a></h1>
<p>This page is under construction. Please come back later.</p>
</div>
</article>
</main>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/elasticlunr.min.js" defer></script>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/search_index.en.js" defer></script>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/js.js" defer></script>
</body>
</html>

191
docs/zola/public/services/northstar/index.html Normal file
View file

@ -0,0 +1,191 @@
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="https://dat-adi.github.io/ff-zola/main.css">
<link rel="icon" href="https://www.getzola.org/favicon.ico">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
<title> Docs | Northstar </title>
</head>
<body>
<script>
fetch('https://api.github.com/repos/getzola/zola/releases/latest')
.then((response) => {
return response.json();
})
.then((data) => {
let release_name = data.name;
let html_url = data.html_url;
release.innerHTML = `<a href='${html_url}'>${release_name}</a>`;
});
</script>
<main>
<nav>
<a href="https:&#x2F;&#x2F;dat-adi.github.io&#x2F;ff-zola&#x2F;">
<img src="https://easydocs.codeandmedia.com/logo.svg" alt="" />
</a>
<div id="release"></div>
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
<div id="trees">
<input class="tree-toggle" type="checkbox" id="services"
checked />
<label class="tree-toggle-label" for="services">Services</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/services/interface/">Interface</a>
</li>
<li class="active">
<a href="https://dat-adi.github.io/ff-zola/services/northstar/">Northstar</a>
</li>
</ul>
<input class="tree-toggle" type="checkbox" id="getting-started"
/>
<label class="tree-toggle-label" for="getting-started">Getting Started</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/getting-started/services/">Services</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/getting-started/intro/">How does it work?</a>
</li>
</ul>
<input class="tree-toggle" type="checkbox" id="solder"
/>
<label class="tree-toggle-label" for="solder">Solder</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/november2020/">November 2020</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/october2020/">October 2020</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/september2020/">September 2020</a>
</li>
</ul>
</div>
</nav>
<article>
<div id="on_right">
<span id="search-ico" class="ms-Icon--Search"></span>
</div>
<div class="search-container">
<input id="search" type="search" placeholder="Search as you type...">
<div class="search-results">
<div class="search-results__header"></div>
<ul class="search-results__items"></ul>
</div>
</div>
<div id="wrap">
<h1 id="northstar">Northstar&nbsp;<a class="anchor" href="#northstar">&#xE732;</a></h1>
<p>This page is under construction. Please come back later.</p>
</div>
</article>
</main>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/elasticlunr.min.js" defer></script>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/search_index.en.js" defer></script>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/js.js" defer></script>
</body>
</html>

36
docs/zola/public/sitemap.xml Normal file
View file

@ -0,0 +1,36 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://dat-adi.github.io/ff-zola/</loc>
</url>
<url>
<loc>https://dat-adi.github.io/ff-zola/getting-started/</loc>
</url>
<url>
<loc>https://dat-adi.github.io/ff-zola/getting-started/intro/</loc>
</url>
<url>
<loc>https://dat-adi.github.io/ff-zola/getting-started/services/</loc>
</url>
<url>
<loc>https://dat-adi.github.io/ff-zola/services/</loc>
</url>
<url>
<loc>https://dat-adi.github.io/ff-zola/services/interface/</loc>
</url>
<url>
<loc>https://dat-adi.github.io/ff-zola/services/northstar/</loc>
</url>
<url>
<loc>https://dat-adi.github.io/ff-zola/solder/</loc>
</url>
<url>
<loc>https://dat-adi.github.io/ff-zola/solder/november2020/</loc>
</url>
<url>
<loc>https://dat-adi.github.io/ff-zola/solder/october2020/</loc>
</url>
<url>
<loc>https://dat-adi.github.io/ff-zola/solder/september2020/</loc>
</url>
</urlset>

43
docs/zola/public/solder/index.html Normal file
View file

@ -0,0 +1,43 @@
<html>
<head>
<title>Zola</title>
</head>
<body>
<div class="container">
<h1>Welcome to Zola!</h1>
<p>
You're seeing this page because we couldn't find a template to render.
</p>
<p>
To modify this page, create a <b>section.html</b> file in the templates directory or
<a href="https://www.getzola.org/documentation/themes/installing-and-using-themes/" target="_blank">install a theme</a>.
<br>
You can find what variables are available in this template in the <a href="https:&#x2F;&#x2F;www.getzola.org&#x2F;documentation&#x2F;templates&#x2F;pages-sections&#x2F;#section-variables" target="_blank">documentation</a>.
</p>
</div>
<footer>
<a href="https://www.getzola.org/documentation/getting-started/cli-usage/" target="_blank">Get started with Zola</a>
</footer>
<style>
html {
line-height: 1.5;
}
h1 {
margin-bottom: 2rem;
}
.container {
font-family: "sans-serif";
text-align: center;
margin-top: 20vh;
padding: 2rem;
background: #e9e9e9;
}
footer {
position: fixed;
width: 100%;
bottom: 1rem;
text-align: center;
}
</style>
</body>
</html>

194
docs/zola/public/solder/november2020/index.html Normal file
View file

@ -0,0 +1,194 @@
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="https://dat-adi.github.io/ff-zola/main.css">
<link rel="icon" href="https://www.getzola.org/favicon.ico">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
<title> Docs | November 2020 </title>
</head>
<body>
<script>
fetch('https://api.github.com/repos/getzola/zola/releases/latest')
.then((response) => {
return response.json();
})
.then((data) => {
let release_name = data.name;
let html_url = data.html_url;
release.innerHTML = `<a href='${html_url}'>${release_name}</a>`;
});
</script>
<main>
<nav>
<a href="https:&#x2F;&#x2F;dat-adi.github.io&#x2F;ff-zola&#x2F;">
<img src="https://easydocs.codeandmedia.com/logo.svg" alt="" />
</a>
<div id="release"></div>
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
<div id="trees">
<input class="tree-toggle" type="checkbox" id="services"
/>
<label class="tree-toggle-label" for="services">Services</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/services/interface/">Interface</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/services/northstar/">Northstar</a>
</li>
</ul>
<input class="tree-toggle" type="checkbox" id="getting-started"
/>
<label class="tree-toggle-label" for="getting-started">Getting Started</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/getting-started/services/">Services</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/getting-started/intro/">How does it work?</a>
</li>
</ul>
<input class="tree-toggle" type="checkbox" id="solder"
checked />
<label class="tree-toggle-label" for="solder">Solder</label>
<ul class="subtree">
<li class="active">
<a href="https://dat-adi.github.io/ff-zola/solder/november2020/">November 2020</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/october2020/">October 2020</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/september2020/">September 2020</a>
</li>
</ul>
</div>
</nav>
<article>
<div id="on_right">
<span id="search-ico" class="ms-Icon--Search"></span>
</div>
<div class="search-container">
<input id="search" type="search" placeholder="Search as you type...">
<div class="search-results">
<div class="search-results__header"></div>
<ul class="search-results__items"></ul>
</div>
</div>
<div id="wrap">
<h1 id="november-2020">November 2020</h1>
<p>Errors were modularized at the back of <a href="https://github.com/forgeflux-org/northstar/">Northstar</a>.
A Docker CI was set up for the Northstar builds.</p>
<p>A <a href="https://github.com/forgeflux-org">GitHub organization</a> was created for ForgeFedv2, and the repositories for the projects were
transferred over to it.</p>
</div>
</article>
</main>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/elasticlunr.min.js" defer></script>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/search_index.en.js" defer></script>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/js.js" defer></script>
</body>
</html>

218
docs/zola/public/solder/october2020/index.html Normal file
View file

@ -0,0 +1,218 @@
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="https://dat-adi.github.io/ff-zola/main.css">
<link rel="icon" href="https://www.getzola.org/favicon.ico">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
<title> Docs | October 2020 </title>
</head>
<body>
<script>
fetch('https://api.github.com/repos/getzola/zola/releases/latest')
.then((response) => {
return response.json();
})
.then((data) => {
let release_name = data.name;
let html_url = data.html_url;
release.innerHTML = `<a href='${html_url}'>${release_name}</a>`;
});
</script>
<main>
<nav>
<a href="https:&#x2F;&#x2F;dat-adi.github.io&#x2F;ff-zola&#x2F;">
<img src="https://easydocs.codeandmedia.com/logo.svg" alt="" />
</a>
<div id="release"></div>
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
<div id="trees">
<input class="tree-toggle" type="checkbox" id="services"
/>
<label class="tree-toggle-label" for="services">Services</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/services/interface/">Interface</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/services/northstar/">Northstar</a>
</li>
</ul>
<input class="tree-toggle" type="checkbox" id="getting-started"
/>
<label class="tree-toggle-label" for="getting-started">Getting Started</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/getting-started/services/">Services</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/getting-started/intro/">How does it work?</a>
</li>
</ul>
<input class="tree-toggle" type="checkbox" id="solder"
checked />
<label class="tree-toggle-label" for="solder">Solder</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/november2020/">November 2020</a>
</li>
<li class="active">
<a href="https://dat-adi.github.io/ff-zola/solder/october2020/">October 2020</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/september2020/">September 2020</a>
</li>
</ul>
</div>
</nav>
<article>
<div id="on_right">
<span id="search-ico" class="ms-Icon--Search"></span>
</div>
<div class="search-container">
<input id="search" type="search" placeholder="Search as you type...">
<div class="search-results">
<div class="search-results__header"></div>
<ul class="search-results__items"></ul>
</div>
</div>
<div id="wrap">
<h1 id="october-2020">October 2020</h1>
<p>In the month of October, there were significant changes to the development in ForgeFedv2.
Starting off with the addition of the <a href="https://forgeflux-org.github.io/northstar/">OpenAPI Specification</a> for Northstar.</p>
<h2 id="northstar">Northstar</h2>
<p>A database model was created to store the details of the various forge interfaces,
having these details would be a prerequisite to looking up a server.</p>
<p>Endpoints were subsequently created, following the defined OpenAPI specification.
While the Lookup service was in the process of development, terminologies and the
concept for Forge Federation was also being <a href="https://github.com/forgeflux-org/spec/tree/master/rfc">discussed</a>.</p>
<p>Docker support as part of the CI process was added into the mix.
Keeping in mind, that the test suite was the method to work with the application for
the time being, an initial working model for the lookup service was established.</p>
<h2 id="interface">Interface</h2>
<p>Development of the <code>libgit</code> library had begun.
[libgit] is a library that processes the contributor's changes, and generates a patch.
Details regarding the implementation and feature set of libgit will be covered in another section.</p>
<h2 id="references">References</h2>
<ul>
<li>Database Initialization :: <a href="https://github.com/forgeflux-org/northstar/commit/6a82a1bc83d4733a5a077e33ad0c222aed496145">database init</a></li>
</ul>
</div>
</article>
</main>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/elasticlunr.min.js" defer></script>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/search_index.en.js" defer></script>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/js.js" defer></script>
</body>
</html>

197
docs/zola/public/solder/september2020/index.html Normal file
View file

@ -0,0 +1,197 @@
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="https://dat-adi.github.io/ff-zola/main.css">
<link rel="icon" href="https://www.getzola.org/favicon.ico">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
<title> Docs | September 2020 </title>
</head>
<body>
<script>
fetch('https://api.github.com/repos/getzola/zola/releases/latest')
.then((response) => {
return response.json();
})
.then((data) => {
let release_name = data.name;
let html_url = data.html_url;
release.innerHTML = `<a href='${html_url}'>${release_name}</a>`;
});
</script>
<main>
<nav>
<a href="https:&#x2F;&#x2F;dat-adi.github.io&#x2F;ff-zola&#x2F;">
<img src="https://easydocs.codeandmedia.com/logo.svg" alt="" />
</a>
<div id="release"></div>
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
<div id="trees">
<input class="tree-toggle" type="checkbox" id="services"
/>
<label class="tree-toggle-label" for="services">Services</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/services/interface/">Interface</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/services/northstar/">Northstar</a>
</li>
</ul>
<input class="tree-toggle" type="checkbox" id="getting-started"
/>
<label class="tree-toggle-label" for="getting-started">Getting Started</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/getting-started/services/">Services</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/getting-started/intro/">How does it work?</a>
</li>
</ul>
<input class="tree-toggle" type="checkbox" id="solder"
checked />
<label class="tree-toggle-label" for="solder">Solder</label>
<ul class="subtree">
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/november2020/">November 2020</a>
</li>
<li >
<a href="https://dat-adi.github.io/ff-zola/solder/october2020/">October 2020</a>
</li>
<li class="active">
<a href="https://dat-adi.github.io/ff-zola/solder/september2020/">September 2020</a>
</li>
</ul>
</div>
</nav>
<article>
<div id="on_right">
<span id="search-ico" class="ms-Icon--Search"></span>
</div>
<div class="search-container">
<input id="search" type="search" placeholder="Search as you type...">
<div class="search-results">
<div class="search-results__header"></div>
<ul class="search-results__items"></ul>
</div>
</div>
<div id="wrap">
<h1 id="september-2020">September 2020</h1>
<p>In the month of September, project &quot;ForgeFedv2&quot; started off by
initializing the lookup service, <a href="https://github.com/forgeflux-org/northstar/">Northstar</a>.</p>
<p>The initialization mostly comprised of setting up the CI environment,
and focused more on defining the structure of the project, and how
we were to be going about it.</p>
<p>A discussion on the terminology and the primitive method of the
project's functionality were discussed.</p>
</div>
</article>
</main>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/elasticlunr.min.js" defer></script>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/search_index.en.js" defer></script>
<script type="text/javascript" src="https://dat-adi.github.io/ff-zola/js.js" defer></script>
</body>
</html>

125
scripts/ci.sh Executable file
View file

@ -0,0 +1,125 @@
#!/bin/bash
# Used in CI workflow: install Zola binary from GitHub
# Copyright © 2021 Aravinth Manivannan <realaravinth@batsense.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
set -euo pipefail
readonly TARBALL=zola.tar.gz
readonly SOURCE="https://github.com/getzola/zola/releases/download/v0.14.0/zola-v0.14.0-x86_64-unknown-linux-gnu.tar.gz"
readonly BIN_PATH=bin
readonly BIN=$BIN_PATH/zola
readonly DIST=public
help() {
cat << EOF
ci.sh: CI build script
USAGE:
ci.sh <options>
OPTIONS:
b build build website
c clean clean dependencies and build artifacts
h help print this help menu
i install install build dependencies
u url make urls relative
z zola invoke zola
EOF
}
check_arg(){
if [ -z $1 ]
then
help
exit 1
fi
}
match_arg() {
if [ $1 == $2 ] || [ $1 == $3 ]
then
return 0
else
return 1
fi
}
download() {
echo "Downloading Zola"
wget --quiet --output-document=$TARBALL $SOURCE
tar -xvzf $TARBALL > /dev/null
rm $TARBALL
echo "Downloaded zola into $BIN"
}
init() {
if [ ! -d $BIN_PATH ]
then
mkdir $BIN_PATH
fi
if [ ! -f $BIN ]
then
cd $BIN_PATH
download
fi
}
run() {
$BIN "${@:1}"
}
build() {
run build
}
no_absolute_url() {
sed -i 's/https:\/\/batsense.net//g' $(find public -type f | grep html)
}
clean() {
rm -rf $BIN_PATH || true
rm -rf $DIST || true
echo "Workspace cleaned"
}
check_arg $1
if match_arg $1 'i' 'install'
then
init
elif match_arg $1 'c' 'clean'
then
clean
elif match_arg $1 'b' 'build'
then
build
elif match_arg $1 'h' 'help'
then
help
elif match_arg $1 'u' 'url'
then
no_absolute_url
elif match_arg $1 'z' 'zola'
then
$BIN "${@:3}"
else
echo "Error: $1 is not an option"
help
exit 1
fi
exit 0