basic fixes to org files

This commit is contained in:
2025-01-18 17:57:56 +00:00
parent ca46b20be1
commit fee39d0afa
21 changed files with 44 additions and 127 deletions

View File

@@ -29,7 +29,7 @@ The Abstractions package consists of black-boxed functions for P2PRC.
--------------
*** Next Chapter: [[file:Implementation.md][Implementation]]
*** Next Chapter: [[file:Implementation.org][Implementation]]
:PROPERTIES:
:CUSTOM_ID: next-chapter-implementation
:END:

View File

@@ -14,17 +14,6 @@ the IP tables from the previous servers.
[[file:images/NumOfHops.png]] [[file:images/clientmoduleArch.png]]
** Topics
:PROPERTIES:
:CUSTOM_ID: topics
:END:
1. [[#updating-the-IP-table][Updating the IP table]]
2. [[#reading-server-specifications][Reading server specifications]]
3. [[#Client-creating-and-removing-container][Client creating and
removing container]]
4. [[#Tracking-Containers][Tracking Containers]]
5. [[#Grouping-Containers][Grouping Containers]]
This section focuses in depth on how the client module works. The client
module is incharge of communicating with different servers based on the
IP addresses provided to the user. The IP addresses are derived from

View File

@@ -2,4 +2,5 @@
:PROPERTIES:
:CUSTOM_ID: domain-name-mappings
:END:
This
Todo be written.

View File

@@ -1,66 +0,0 @@
* Implementation
:PROPERTIES:
:CUSTOM_ID: implementation
:END:
| [[file:Introduction.md][◀ Previous]] | [[file:README.md][Back to TOC]] |
|--------------------------------------+---------------------------------|
This chapter describes how the project was built. It talks in depth of
the implementation performed to give a better understanding of the
project.
** Programming langauge used
:PROPERTIES:
:CUSTOM_ID: programming-langauge-used
:END:
The programming language used for this project was
[[https://go.dev/][Golang]]. The reason Go lang was chosen was because
it is a compiled language. The entire codebase is just a single binary
file. When distributing to other linux distributing the only requirement
would be the binary file to run the code. It is easy to write
independant modules and be monolithic at the sametime using Go. Using
Go.mod makes it very easy to handle external libraries and modularise
code. The go.mod name for the project is
[[https://git.sr.ht/~akilan1999/p2p-rendering-computation][git.sr.ht/~akilan1999/p2p-rendering-computation]].
-
** [[file:CliImplementation.md][Cli Module]]
:PROPERTIES:
:CUSTOM_ID: cli-module
:END:
-
** [[file:ConfigImplementation.md][Config Module]]
:PROPERTIES:
:CUSTOM_ID: config-module
:END:
-
** [[file:ServerImplementation.md][Server Module]]
:PROPERTIES:
:CUSTOM_ID: server-module
:END:
-
** [[file:ClientImplementation.md][Client Module]]
:PROPERTIES:
:CUSTOM_ID: client-module
:END:
-
** [[file:P2PImplementation.md][P2P Module]]
:PROPERTIES:
:CUSTOM_ID: p2p-module
:END:
-
** [[file:PluginImplementation.md][Plugin Module]]
:PROPERTIES:
:CUSTOM_ID: plugin-module
:END:
-
** [[file:GenerateImplementation.md][Generate Module]]
:PROPERTIES:
:CUSTOM_ID: generate-module
:END:

21
Docs/Implementation.org Normal file
View File

@@ -0,0 +1,21 @@
* Implementation
:PROPERTIES:
:CUSTOM_ID: implementation
:END
This chapter describes how the project was built. It talks in depth of
the implementation performed to give a better understanding of the
project.
** Programming language used
:PROPERTIES:
:CUSTOM_ID: programming-langauge-used
:END:
The programming language used for this project was
[[https://go.dev/][Golang]]. The reason Go lang was chosen was because
it is a compiled language. The entire codebase is just a single binary
file. When distributing to other linux distributing the only requirement
would be the binary file to run the code. It is easy to write
independant modules and be monolithic at the sametime using Go. Using
Go.mod makes it very easy to handle external libraries and modularise
code. The go.mod name for the project is
[[https://git.sr.ht/~akilan1999/p2p-rendering-computation][git.sr.ht/~akilan1999/p2p-rendering-computation]].

View File

@@ -2,8 +2,6 @@
:PROPERTIES:
:CUSTOM_ID: installation
:END:
| [[file:Introduction.md][◀ Previous]] | [[file:Abstractions.md][Next ▶]] |
|--------------------------------------+----------------------------------|
Over here we will cover the basic steps to get the server and client
side running.
@@ -351,11 +349,4 @@ This feature is still Under Development:
Refer the section [[#install-docker][Install Docker]]. - =cd plugin= -
=go test .=
#+end_quote
--------------
*** Next Chapter: [[file:Abstractions.md][Abstractions]]
:PROPERTIES:
:CUSTOM_ID: next-chapter-abstractions
:END:
#+end_quote

View File

@@ -2,8 +2,6 @@
:PROPERTIES:
:CUSTOM_ID: chapter-1-introduction
:END:
| [[file:README.md][◀ Back to TOC]] | [[file:Installation.md][Next ▶]] |
|-----------------------------------+----------------------------------|
** Abstract
:PROPERTIES:
@@ -38,11 +36,4 @@ useful. Ethically speaking this is leading to monopolisation of
computing power similar to what is happening in the web server area. By
using peer to peer principles it is possible to remove the
monopolisation factor and increase the bandwidth between the client and
server.
--------------
*** Next Chapter: [[file:Installation.md][Installation]]
:PROPERTIES:
:CUSTOM_ID: next-chapter-installation
:END:
server.

View File

@@ -2,16 +2,6 @@
:PROPERTIES:
:CUSTOM_ID: plugin-module-implementation
:END:
** Topics
:PROPERTIES:
:CUSTOM_ID: topics
:END:
1. [[#introduction][Introduciton]]
2. [[#site-File-Template][Site.yml]]
3. [[#hosts-file][Host]]
4. [[#description-file][Description]]
5. [[#automatic-port-allocations][Automatic port allocations]]
6. [[#sample-plugins-implemented][Sample plugins implemented]]
** Introduction
:PROPERTIES:

View File

@@ -1,18 +0,0 @@
* Table of contents
:PROPERTIES:
:CUSTOM_ID: table-of-contents
:END:
1. [[file:Introduction.md][Introduction]]
2. [[file:Installation.md][Installation]]
3. [[file:Abstractions.md][Abstractions]]
4. [[file:Implementation.md][Implementation]]
1. [[file:ClientImplementation.md][Client Module]]
2. [[file:P2PImplementation.md][P2P Module]]
3. [[file:ServerImplementation.md][Server Module]]
4. [[file:ConfigImplementation.md][Config Module]]
5. [[file:CliImplementation.md][Cli Module]]
6. [[file:PluginImplementation.md][Plugin Module]]
7. [[file:Bindings.md][Language bindings]]
8. [[file:Bindings.md][Domain name mappings]]
5. Language bindings
1. [[file:haskell/][Haskell]]

18
Docs/README.org Normal file
View File

@@ -0,0 +1,18 @@
* Table of contents
:PROPERTIES:
:CUSTOM_ID: table-of-contents
:END:
1.[[file:Introduction.org][ Introduction]]
2. [[file:Installation.org][Installation]]
3. [[file:Abstractions.org][Abstractions]]
4. [[file:Implementation.org][Implementation]]
1. [[file:ClientImplementation.org][Client Module]]
2. [[file:P2PImplementation.org][P2P Module]]
3. [[file:ServerImplementation.org][Server Module]]
4. [[file:ConfigImplementation.org][Config Module]]
5. [[file:CliImplementation.org][Cli Module]]
6. [[file:PluginImplementation.org][Plugin Module]]
7. [[file:Bindings.org][Language bindings]]
8. [[file:Bindings.org][Domain name mappings]]
5. Language bindings
1. [[file:haskell/][Haskell]]