updated smaller collections for manual

collections/collaboration/collaboration_tools/circle_tool.md

@@ -0,0 +1,113 @@
+<h1> ThreeFold Circle Tool </h1>
+
+<h2>Table of Contents</h2>
+
+- [Introduction](#introduction)
+- [Overview](#overview)
+- [Prerequisites](#prerequisites)
+- [How to Use the Circle Tool](#how-to-use-the-circle-tool)
+- [Circle Tool Overview](#circle-tool-overview)
+- [Dashboard View](#dashboard-view)
+- [Profile view](#profile-view)
+- [Projects](#projects)
+- [Scrum Module on Project](#scrum-module-on-project)
+  - [Scrum Backlog](#scrum-backlog)
+  - [Scrum Sprints](#scrum-sprints)
+- [More Info](#more-info)
+
+***
+
+## Introduction
+
+The [__ThreeFold Circle Tool__](https://circles.threefold.me ) is our own self-hosted (desktop only) project management tool based on [Taiga](https://www.taiga.io/), an open-source project management tool for cross-functional agile. It offers a lot of different project management kits and features such as the scrum board, kanban board, issues management, and many more. 
+
+Our teams at ThreeFold use the Circle Tool to self-manage our tasks, thus it is deemed necessary for the new onboarded team members to learn how to use the tool. Unfortunately we only provide the desktop version of the tool at this moment since we normally manage our projects on the computer.
+
+This manual will be a beneficial thing to read for anyone: our team members, as well as our community members who are interested in using Circle Tool for their projects.
+
+## Overview
+
+Here is an overview of the tool.
+
+![ ](./img/taiga.png)
+
+## Prerequisites
+
+You would need to install and create an account on the [TF Connect App](../../../documentation/threefold_token/storing_tft/tf_connect_app.md) before being able to register and use the Circle Tool.
+
+## How to Use the Circle Tool
+
+* Go to [Circle Tool's desktop homepage](https://circles.threefold.me) on your computer as shown below. Click on '__Login__' button on the very top right corner of your screen.
+
+![ ](./img/circlehome.png)
+
+* Click on "TF Connect" button to log into the Circle Tool by using your TF Connect Account.
+
+![ ](./img/tfconnect.png)
+
+* Fill in your TF Connect usernames (without adding the '@' sign) on the provided box, and click on the 'Sign in' button.
+
+![ ](./img/signin.png)
+
+* Circle Tool will ask you to verify your login by clicking the right emoji that is sent to your TF Connect App.
+
+![ ](./img/emoji.png)
+
+* Verify your sign in process by loggin in to your TF Connect App on your mobile phone. Click on the same emoji that you see on your circle tool (desktop).
+
+![ ](./img/matchemoji.png)
+
+* Congratulations, you are now officially logged in on the circle tool. The Dashboard view will be the first thing you will see once you are logged in to the tool.
+
+![ ](./img/dashboard.png)
+
+***
+
+## Circle Tool Overview
+
+The Circle Tool always try to make things easy and intuitive for new users but it’s good to have a nice & quick overview for your first couple of days.
+
+## Dashboard View
+
+![ ](./img/dashboard.png)
+
+Upon login or if you just go to your Circle Tool, you’re confronted with your dashboard with quick access to your working on items, a list of watched items and shortcuts to your projects. You can always go back to your dashboard by clicking on the Taiga 
+icon on the top bar.
+
+## Profile view
+
+![ ](./img/profile.png)
+
+Circle Tool has an additional section to get a multiproject view where you can find and list everything that is accessible to you. Simply click on your avatar and you access your personal profile section where you can check from what your personal bio looks like for people that might have access to it to all sorts of information on your activities and relevant content.
+
+## Projects
+
+![ ](./img/project.png)
+
+You can access your assigned projects by clicking on Projects link at the top left of your screen. You can hover and get an interactive shortlist or click on the link and go to a dedicated page where you can access them as well as rearrange them. Once you have clicked on a project, you access your default view for that project, which is always the Project’s Timeline if you haven’t changed that.
+
+
+## Scrum Module on Project
+
+![ ](./img/homeproject.png)
+
+Every circle project can activate the Scrum module. This also happens automatically if you chose the Scrum template upon project creation. You can find the scrum module on the sidebar of your project page. 
+
+Scrum is an agile framework for developing, delivering, and sustaining complex products. Although it had an initial emphasis on software development, it has been used in other fields including research, sales, marketing and advanced technologies. 
+
+### Scrum Backlog
+
+![ ](./img/backlog.png)
+
+There are various so called artifacts in Scrum. The top three are the Backlog, the User Stories and the Sprints. They respectively represent what is to be done ordered by priority and readyness, the pieces of work themselves and the fixed time periods in which we put selected User Stories to be worked upon and finished.
+
+### Scrum Sprints
+
+![ ](./img/sprints.png)
+
+The Scrum Backlog view will always show a summary view of ongoing or closed Sprints but teams generally stick to the Sprint Taskboard view when they are focused on getting things done for that Sprint. Click on either the Sprint name or the “Sprint Taskboard” button so you can access the very important Sprint Taskboard. Open Sprints appear as shortcuts through the left navigation pane’s Scrum icon.
+
+
+## More Info
+
+You can read more about the Circle Tool (Taiga), scrum, sprints, and other documentations on Taiga's project management features on Taiga's official documentation [here](https://community.taiga.io/). Happy Project Managing!

collections/collaboration/collaboration_tools/collaboration_tools.md

@@ -0,0 +1,18 @@
+<h1> ThreeFold's Collaboration Tools </h1>
+
+In this section, we will introduce powerful collaboration tools utilized by ThreeFold, such as the Circle Tool and the Website Deployer. 
+
+These tools play a crucial role in enhancing as well as simplifying collaboration and communication at ThreeFold. The tools we use at ThreeFold are chosen for their open-source design and their focus on ease of comprehension and use. 
+
+<h2>Table of Contents</h2>
+
+- [Circle Tool](./circle_tool.md)
+  - This ThreeFold's project management tool, made by using Taiga, is an open-source project management platform designed to facilitate collaboration and to streamline workflows for teams. It provides a comprehensive set of features and tools to help teams plan, track, and manage their projects effectively. 
+
+- [Website Deployer](./website_tool.md)
+  - This ThreeFold's website builder tool, made by using Zola, is a static site generator (SSG) and content management system (CMS) that empowers developers and content creators to build and manage websites efficiently. It is an open-source framework written in the Rust programming language, known for its performance, security, and reliability. 
+
+- [Website Link Checker](./website_link_checker.md)
+  - The ThreeFold website link checker is a wrapper around muffet to check for specific link errors on live websites written in Python.
+
+ 

collections/collaboration/collaboration_tools/website_link_checker.md

@@ -0,0 +1,87 @@
+<h1> Website Link Checker </h1>
+
+<h2> Table of Contents </h2>
+
+- [Introduction](#introduction)
+- [How the Program Exits](#how-the-program-exits)
+- [Program Arguments](#program-arguments)
+- [How to Use the Program](#how-to-use-the-program)
+  - [With Python](#with-python)
+  - [With Docker](#with-docker)
+  - [With Github Action](#with-github-action)
+
+***
+
+## Introduction
+
+This is a Python program that calls muffet on a whole website and then filters and displays the HTTP errors.
+
+> Note: It can take a couple of minutes to run if the website has a lot of URLs.
+
+## How the Program Exits
+
+Exits with error code 1 if at least one error is found, as specified with --errors
+flag. Otherwise exits with code 0. Note that errors set as --warnings will always exit with code 0.
+
+## Program Arguments
+
+* url
+  * The URL to scan. Please include https:// or http://. (e.g. https://google.com)
+* -h, --help            
+  * show this help message and exit
+* -e ERRORS [ERRORS ...], --errors ERRORS [ERRORS ...]
+  * Specify one, many or all error codes to be filtered (e.g. -e 404, -e 403 404, -e all). Use -e all to show all errors.
+* -w WARNINGS [WARNINGS ...], --warnings WARNINGS [WARNINGS ...]
+  * Specify one, many or all error codes to be filtered as warnings (e.g. -w 404, -w 403 404, -w all). Use -w all to show all warnings.
+
+## How to Use the Program
+
+### With Python
+
+* Clone the repository
+  * ```
+    git clone https://github.com/threefoldfoundation/website-link-checker
+    ```
+* Change directory
+  * ```
+    cd website-link-checker
+    ```
+* Run the program
+  * ```
+    python website-link-checker.py https://example.com -e 404 -w all
+    ```
+
+### With Docker
+
+You can use the following command to run the website link checker with Docker:
+
+```
+docker run ghcr.io/threefoldfoundation/website-link-checker https://example.com -e 404 -w all
+```
+
+### With Github Action
+
+The website link checker can be run as an action (e.g. `action.yml`) set in `.github/workflows` of a Github repository.
+
+The following action example runs everytime there is a push on the development branch and also every Monday at 6:00AM as set by the cron job.
+
+```
+name: link-checker-example
+on:
+  push:
+    branches: [ development ]
+  schedule:
+    - cron: '0 6 * * 1' # e.g. 6:00 AM each Monday
+
+jobs:
+  job_one:
+    name: Check for Broken Links
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check for Broken Links
+        id: link-report
+        uses: docker://ghcr.io/threefoldfoundation/website-link-checker:latest
+        with:
+          args: 'https://example.com -e 404 -w all'
+```
+

collections/collaboration/collaboration_tools/website_tool.md

@@ -0,0 +1,338 @@
+<h1> Zola Website Deployer</h1>
+
+<h2> Table of Contents </h2>
+
+- [Overview](#overview)
+  - [What is Zola Framework?](#what-is-zola-framework)
+- [Prerequisites](#prerequisites)
+  - [Important Links](#important-links)
+- [Installing Zola Onto Your Machine](#installing-zola-onto-your-machine)
+  - [Important Links](#important-links-1)
+- [Get Started](#get-started)
+  - [Fork ThreeFold's Website Template to Your Github Account](#fork-threefolds-website-template-to-your-github-account)
+  - [Clone the Forked Repository Locally](#clone-the-forked-repository-locally)
+  - [Open and Edit Your Cloned Zola Template with a Code Editor](#open-and-edit-your-cloned-zola-template-with-a-code-editor)
+  - [Template Guide](#template-guide)
+  - [Navigating the Template](#navigating-the-template)
+  - [Top Navbar Made Easy](#top-navbar-made-easy)
+  - [Replace Logo with your Own logo](#replace-logo-with-your-own-logo)
+  - [Important Links](#important-links-2)
+- [Customization](#customization)
+  - [Some Tutorials on Markdown](#some-tutorials-on-markdown)
+  - [Creating A Single-Column Page Section](#creating-a-single-column-page-section)
+  - [Adding Image](#adding-image)
+  - [Creating Page Section with Multiple Columns](#creating-page-section-with-multiple-columns)
+  - [Important Links](#important-links-3)
+  - [Build and Preview Your Website Locally](#build-and-preview-your-website-locally)
+  - [Check the Website Links](#check-the-website-links)
+  - [Important Links](#important-links-4)
+- [Publish Your Website (Via Github Pages)](#publish-your-website-via-github-pages)
+  - [Publish your Github page](#publish-your-github-page)
+- [Important Links](#important-links-5)
+- [Questions and Feedback](#questions-and-feedback)
+
+***
+
+## Overview
+
+**ThreeFold Website Tool** is a customized open-source Zola-based web deployment framework and static website template repository that is available for anyone to use.
+
+At ThreeFold, we utilized Website Tool to deploy all of our web presences. For example, [**www.threefold.io**](https://threefold.io).
+
+### What is Zola Framework?
+[**Zola**](https://www.getzola.org/) is a static site generator (SSG), similar to Hugo, Pelican, and Jekyll (for a comprehensive list of SSGs, please see Jamstack). It is written in Rust and uses the Tera template engine, which is similar to Jinja2, Django templates, Liquid, and Twig. Content is written in CommonMark, a strongly defined, highly compatible specification of Markdown.
+
+While you can also publish a static website using Zola alone, we at ThreeFold have customized the framework and created a static website template that makes it even easier for anyone to build a website by simply cloning template and fill it with their own website content.
+
+
+
+## Prerequisites
+
+- Github Account
+- Zola Framework
+- VS Code, or any code editor of choice
+- Markdown language knowledge
+- Basic Command Line (Terminal) Knowledge
+
+In order to deploy and publish a website using ThreeFold Website Tool, you would need to have an account on github (to store your website data in a github repository), as well as to have Zola framework installed on your machine.
+
+### Important Links
+
+> - [How to Sign Up for a Github Account](https://docs.github.com/en/get-started/signing-up-for-github/signing-up-for-a-new-github-account)
+> - [Download VS Code](https://code.visualstudio.com/download)
+> - [Learn Markdown Language](https://www.markdownguide.org/)
+> - [Command Line Cheat Sheet](https://cs.colby.edu/maxwell/courses/tutorials/terminal/)
+
+
+
+## Installing Zola Onto Your Machine
+
+To install Zola on your machine, simply go to your terminal and run the following command:
+
+**MacOS (brew)**:
+
+```
+$ brew install zola
+```
+Please make sure you have [Brew](https://brew.sh/) installed on your MacOS machine before installing Zola. 
+
+<b>Windows (scoop)</b>:
+
+```
+$ scoop install zola
+```
+Please make sure you have [Scoop](https://scoop.sh/) installed on your Windows machine before installing Zola.
+
+You should see a similar screen as below when successful:
+
+![](./img/scoopsuccess.png)
+
+For more details on Zola Installation, and installation guidelines for other operating systems, please read: [**Zola Installation Manual**](https://www.getzola.org/documentation/getting-started/installation/).
+
+
+### Important Links
+> - [How to Install Brew (MacOS)](https://brew.sh/)
+> - [How to Install Scoop (Windows)](https://github.com/ScoopInstaller/Scoop#readme)
+> - [Zola Installation for other OS](https://www.getzola.org/documentation/getting-started/installation/)
+> - [Command Line Cheat Sheet](https://cs.colby.edu/maxwell/courses/tutorials/terminal/)
+
+> Next Step: [Template Guide: How to use the TF Web Template](#template-guide)
+
+
+
+## Get Started
+
+Now that you have successfully installed Zola on your machine. You are ready to create and build your own website using ThreeFold Website Tool. 
+
+In order to do that you would need to clone [**ThreeFold's Website Template**](https://github.com/threefoldfoundation/www_examplezola) to your own github account, and open it locally on your computer by using VS Code or your code editing program of choice.
+
+### Fork ThreeFold's Website Template to Your Github Account
+
+Our Team has especially created an html/css/markdown based template repository on github, free for anyone to use. To start working on your project, simply fork [this repository](https://github.com/threefoldfoundation/www_examplezola) to your own github account by clicking the 'fork' account on the repository, and rename it with your website's name.
+
+![](./img/fork.png)
+
+### Clone the Forked Repository Locally
+After you forked the template, now you can [clone the repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) to your local computer so we can start working on it. Please remember the directory / folder of where you cloned the repository in your computer to make it easier for you to locate and edit it.
+
+
+![](./img/clone.png)
+
+### Open and Edit Your Cloned Zola Template with a Code Editor
+
+Once the template is forked and cloned, open your code editor and start working on your website. I will explain a little more about the content editing process and procedure on the next pages...
+
+![](./img/vscode.png)
+
+### Template Guide
+
+On this page you will find an introduction on [TF Web Template](https://github.com/threefoldfoundation/www_examplezola) and how to navigate the different template component that enable you to edit the template with your own content.
+
+### Navigating the Template
+
+All editable content of your website would be found under **‘content’** folder. 
+Each page of your website is a **markdown (.md) file.**
+
+Each page and all the images on the page will be put into its own folder under content/ folder. 
+![](./img/folderdetail.png)
+<br>
+For example, here, my homepage (index.md) is put into **content/home** folder.
+![](./img/indexmd.png)
+
+If I want to edit the homepage of my website, I would go to the following:
+bb
+```
+content/home/index.md
+```
+ and start editing.
+
+ ![](./img/vscode.png)
+
+ ### Top Navbar Made Easy
+
+![](./img/navbar.png)
+
+Every time you make a new page folder, we have designed it in a way that the website would automatically generate a new navbar item using the name of each folder you created.
+
+ based on the navbar picture above, it means that I have created 3 separate content subfolders, each with an index.md file on it called Home, ThreeFoldFeed and GetServer.
+
+### Replace Logo with your Own logo
+![](./img/logo.png)
+
+To replace the logo, **add your own logo image to ‘home’ folder.**
+
+And then go to **_index.md** file and replace the **logo_path**: images/yourlogoimagename.jpg
+
+![](./img/placeholder.png)
+
+### Important Links
+
+> - [TF Web Template](https://github.com/threefoldfoundation/www_examplezola)
+
+
+
+## Customization
+
+We have designed the template in certain ways that it would accommodate different indentation web page style, such as placeholders, footer, header, left-indentation, right-indentation.
+
+All you need to do is just replace the texts and images using markdown language, and use the indentation style you would like to use for your page. Don’t know how to markdown? Here’s a [**complete markdown syntax guide**](https://www.markdownguide.org/basic-syntax/) for you to begin with.
+
+ Happy experimenting!
+
+### Some Tutorials on Markdown
+
+### Creating A Single-Column Page Section
+
+Since we only have one column, Every one column section begins only with row indentation syntax (style, margin, padding).
+
+
+```
+<!-- section 1 (header) -->
+
+{% row(style="" margin="" padding="t") %}
+```
+
+for example:
+
+```
+<!-- section 1 (header) -->
+
+{% row(style="center" margin="narrow" padding="top") %}
+```
+
+and ends with 
+
+```
+{% end %}
+```
+
+### Adding Image
+
+To add image to your page please use 
+
+```
+![alt_text](yourimagename.png)
+```
+
+The Result:
+
+![](./img/mastodon.png)
+
+
+### Creating Page Section with Multiple Columns
+
+For more than one column section, we need to configure the row and column syntax.
+For example:
+Sometimes you would like to have a page where you place your texts and buttons on left column and an image on the right column, like:
+
+What you need to do is add:
+
+```
+|||
+```
+in between your text and images for every column you want to create.
+
+For example, this page consist of two columns (left and right):
+
+![](./img/twocolumns.png)
+
+The Result:
+
+![](./img/twocolumnsdone.png)
+
+You can add more than two column like this one, a page section consist of 3 columns.
+
+The code:
+
+![](./img/threecolumns.png)
+
+The Result:
+
+![](./img/threecolumnsdone.png)
+
+
+### Important Links
+> - [Learn Markdown Language](https://www.markdownguide.org/)
+
+###  Build and Preview Your Website Locally
+
+After customizing your website, you might want to review and build your website locally before publishing it online. On this page you will find tutorials on how to preview and deploy your website.
+
+To preview your website locally, simply open the terminal via your code editor and type in:
+
+```
+./build.sh
+```
+
+So that the framework starts building your website.
+
+Then
+
+```
+./start.sh
+```
+
+So that the framework starts serving your website preview locally. Please make sure you are on located on the right website folder, for example: *$ user/doc/mywebsitename* before typing the command above. 
+ 
+ The preview won't successfuly be built if you run the command in the wrong folder.
+
+When successful, it will give you a link to a local preview of your website. Go ahead and copy paste the url onto your web browser to preview your website locally.
+
+![](./img/success.png)
+
+And, Congratulations! You just built your website locally!
+
+![](./img/preview.png)
+
+### Check the Website Links
+
+When you are in the main directory of your Zola website, you can check the following command to check the links of the complete website locally:
+
+```
+zola check
+```
+
+Once your website is online, you can also use the [Website Link Checker](./website_link_checker.md).
+
+### Important Links
+
+> - [Command Line Cheat Sheet](https://cs.colby.edu/maxwell/courses/tutorials/terminal/)
+
+
+
+## Publish Your Website (Via Github Pages)
+
+Since we're using github repository to save our website content, the easiest way to publish our website is also through github pages and by using our own domain.
+
+Once all commits have been pushed back to your github repository online, you can start publishing your website.
+
+The first thing you need to do is to go back to your code editor, and find **config.toml** file on your website repo. 
+Edit the **base_url** on the **config.toml** file on your repo to your own domain.
+
+![](./img/config.png)
+
+Save all your changes and push all your commits to its origin again.
+
+### Publish your Github page
+
+Later on, go to your github repo **settings**, go to **Pages** on the left navigation sidebar. Add your own custom domain to start publishing your website.
+
+![](./img/gitpages.png)
+
+
+And you are done! Your website will be published, and it will take only a minute or so to complete the process. Refresh page, and you will see a link to your newly published website.
+
+![](./img/done.png)
+
+
+
+## Important Links
+> - [Pushing Changes to Github](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/pushing-changes-to-github)
+> - [Github Pages How-to](https://docs.github.com/en/pages)
+> - [Adding Custom Domain to my Github Page](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages)
+
+
+
+## Questions and Feedback
+
+If you have any question or feedback, you can write a post on the [ThreeFold Forum](http://forum.threefold.io/).