Skip to content
This repository has been archived by the owner on Dec 18, 2023. It is now read-only.

Commit

Permalink
Merge pull request #107 from bobidle/fix_typos
Browse files Browse the repository at this point in the history
Fix typos and remove whitespace characters
  • Loading branch information
andibraeu authored Oct 27, 2023
2 parents 5949958 + bf8ebe4 commit 1b613c6
Show file tree
Hide file tree
Showing 27 changed files with 59 additions and 59 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Answer

### Advanced way

* install ruby and gem as prerequsites
* install ruby and gem as prerequisites
* install jekyll: ```sudo gem install jekyll bundler```
* checkout projects software ```git checkout https://github.com/freifunk/projects```
* delete contents of the original software
Expand Down
2 changes: 1 addition & 1 deletion collections/_faq/003_application_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Your GSoC Project
* Project Details - more detailed description
* Project Size - choose to spend 175 hours or 350 hours.
* Project Schedule - provide a rough timetable with milestones for every 2 weeks
* Availability - How do you plan to spend the designated work hours during the summer? Do you choose the standard
* Availability - How do you plan to spend the designated work hours during the summer? Do you choose the standard
After GSoC
-----
Expand Down
2 changes: 1 addition & 1 deletion collections/_faq/005_contact_to_mentors.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ order: 5
---
We act as an umbrella organization, so there are a bunch of possibilities to contact mentors. Most of our mentors can be contacted via GitHub. Please try to contact your mentor first!

If you're in doubt or don't know the project location, ask our [international Mailinglist](https://lists.freifunk.net/mailman/listinfo/wlanware-freifunk.net) or at [matrix](https://matrix.to/#/!DmXQbxcSxGYgXDYrBs:bau-ha.us?via=bau-ha.us). Please keep in mind that people there don't know the projects or your ideas in detail!
If you're in doubt or don't know the project location, ask our [international mailing list](https://lists.freifunk.net/mailman/listinfo/wlanware-freifunk.net) or at [matrix](https://matrix.to/#/!DmXQbxcSxGYgXDYrBs:bau-ha.us?via=bau-ha.us). Please keep in mind that people there don't know the projects or your ideas in detail!
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ There are many ways to introduce yourself to the communities. A lot of communiti

Over the year there are a lot of opportunities to meet community members at several events. We host the Wireless Community Weekend in May in Germany, there's the Battlemesh every year in another place in Europe. Communities represent themselves at events like FOSDEM in Brussels, the Chaos Communication Congress, or the Chaos Communication Camp.

When your proposal gets accepted you'll also get a blog account to show your project's progress and results.
When your proposal gets accepted you'll also get a blog account to show your project's progress and results.
6 changes: 3 additions & 3 deletions collections/_projects/elrepo.io.desktoip_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,17 @@ collaborating_projects:
- Altermundi
---

[ElRepo.io](https://elrepo.io) is a decentralized repository of culture built on RetroShare API client.
[ElRepo.io](https://elrepo.io) is a decentralized repository of culture built on RetroShare API client.
The actual app is developed with Flutter and supports Android systems. However, Flutter framework gives
the possibility to build apps to different platforms from a single codebase.

- One possibility is to experiment how to pack a flutter web app into an Electron app to distribute it
- One possibility is to experiment how to pack a flutter web app into an Electron app to distribute it
as desktop app.

- Other one is experiment with Flutter native desktop framework to distribute a binary for each platform.

#### Milestones

- Knowing basic of how Flutter and Dart work is needed.
- Knowing basic of how Flutter and Dart work is needed.
- Create a plugin capable to interact with RetroShare for each platform (start, stop it, bundle it)
- Create different versions of the app and check what is the fastest way to distribute a multiplatform package.
10 changes: 5 additions & 5 deletions collections/_projects/elrepo.io.openwrt_implementation.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ collaborating_projects:
- Altermundi
---

[ElRepo.io](https://elrepo.io) is a decentralized repository of culture built on RetroShare API client.
The actual app is developed with Flutter and supports Android systems.
[ElRepo.io](https://elrepo.io) is a decentralized repository of culture built on RetroShare API client.
The actual app is developed with Flutter and supports Android systems.

ElRepolib library is written on pure Dart language and could be ported to ARM devices with some Research.
And what about Flutter framework?
ElRepolib library is written on pure Dart language and could be ported to ARM devices with some Research.
And what about Flutter framework?

A future implementation for elRepo.io is living on routers or other embed devices improving shared
A future implementation for elRepo.io is living on routers or other embed devices improving shared
networks experience, being a place where exchange any type of media or text.
10 changes: 5 additions & 5 deletions collections/_projects/freifunk_goes_100G.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,16 @@ tags:
- Linux Kernel
---

Current Freifunk Community networks accross Europe are expanding their wireless P2P backbone infrastruture to wired fibre links, hence capacities beyond 10GBit/s are achieveable.
Today's switching hardware can be categorised into three design aproaches:
- Switch Abstraction Interface (SAI) [1] which is leveraged by SONiC (NOS) [2]
Current Freifunk Community networks across Europe are expanding their wireless P2P backbone infrastructure to wired fibre links, hence capacities beyond 10GBit/s are achievable.
Today's switching hardware can be categorised into three design approaches:
- Switch Abstraction Interface (SAI) [1] which is leveraged by SONiC (NOS) [2]
- OF-CONFIG [3] which enables to configure the forwarding plane of Broadcom-based switches
- Switchdev (Linux kernel API [4]), which could be leveraged by the Distributed Switch Architecture (DSA) [5]

Moreover, other approaches exist to expose the packet handling/forwarding into the user space
- DPDK/VPP interface that would require a significant re-emplementation of the Freifunk network stack and features such as olsrd/batman/babel routing deamons. The flexible switchdev Linux kernel API builds upon standard Linux tools such as IP etc. this enables Freifunk communities to code as well as add features running atop a classical Linux-based system also on devices beyond 10 Gbps interfaces. Since NVIDIA Mellanox Spectrum II switches implement the Linux kernel switchdev API, they seem to be a reasonable choice to achieve this goal.
- DPDK/VPP interface that would require a significant re-implementation of the Freifunk network stack and features such as olsrd/batman/babel routing daemons. The flexible switchdev Linux kernel API builds upon standard Linux tools such as IP etc. this enables Freifunk communities to code as well as add features running atop a classical Linux-based system also on devices beyond 10 Gbps interfaces. Since NVIDIA Mellanox Spectrum II switches implement the Linux kernel switchdev API, they seem to be a reasonable choice to achieve this goal.

Accordingly, the goal of this project is to port Freifunk/OpenWrt [6] OS to the Mellanox Spectrum II-based switch[7] hardware - in such a way, that the ONIE [8] bootloader triggers an OpenWrt boot, daemons such as olsrd/batman/babel routing deamons can run as usual, and (Q)SFP-based ports are deployable on fiber links.
Accordingly, the goal of this project is to port Freifunk/OpenWrt [6] OS to the Mellanox Spectrum II-based switch[7] hardware - in such a way, that the ONIE [8] bootloader triggers an OpenWrt boot, daemons such as olsrd/batman/babel routing daemons can run as usual, and (Q)SFP-based ports are deployable on fiber links.

#### Resources

Expand Down
2 changes: 1 addition & 1 deletion collections/_projects/google_coral_board_support.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ tags:
- Linux Kernel
---

The Coral Board integrates a Google Coral Edge Tensor Processing Unit (TPU) as Mini PCIe Accelerator [1],
The Coral Board integrates a Google Coral Edge Tensor Processing Unit (TPU) as Mini PCIe Accelerator [1],
M.2 Accelerator A+E key or via USB. The TPU can be leveraged to run TensorFlow Light models on embedded systems. The goal is to integrate the board and environment into the OpenWrt build environment [2].

Moreover, within the GSoC project, the task is to come up with a simple example [3] to demonstrate the capabilities of the Coral board. Thus, the goal is to develop and evaluate some use cases such as device fingerprinting etc.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ In Linux-based devices, the resource allocation is handled in the mac80211 kerne

* Implement a simple rate and power control for desk experiments with complete documentation.
* Test and validate transmit power control for mt76 and ath9k driver.
* Concrete formulation of the the final joint rate and power control with proper evaluation.
* Concrete formulation of the final joint rate and power control with proper evaluation.
* Create diagram/s to depict the software architecture of the proposed joint rate and power control.

##### GSOC FINAL
Expand Down
2 changes: 1 addition & 1 deletion collections/_projects/libremesh-automation_monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Similar projects or packages:
https://gitlab.com/librerouter/miniserver
https://github.com/libremesh/lime-packages/tree/master/packages/altermundi-grafana

The use case is a growing fragmented network with islands of nodes and users; but with a collective management having an overarching vision on what is happening in the network and giving feedback to the users by the [Lime-App](https://github.com/libremesh/lime-app).
The use case is a growing fragmented network with islands of nodes and users; but with a collective management having an overarching vision on what is happening in the network and giving feedback to the users by the [Lime-App](https://github.com/libremesh/lime-app).

Create a set of Ansible roles to replicate the OpenWrt build-system, to speed-up the process of self-building images for OpenWrt and/or LibreMesh for newcomers, and to easily setup a dedicated machine, with the possibility to later extend the process of build to other automated tasks, like a pub-keys-exchange needed for configuring a VPN, or to update documentations or a webapp.
The Ansible roles would include tasks to build for: different architectures and targets; different OpenWrt and LibreMesh versions; keeping trace of devices with particular needs and related patches; keeping a local list of supported targets; provide a basic functionality to setup a VPN. This should also provide a main configuration file for each device, and the use of the main configuration tools available on LibreMesh, like +/etc/config/lime-*+ and especially +lime-macaddress+ files, "generic-uci-config, lime-asset" functionalities, and configurations and packages provided by community [network-profiles](https://github.com/libremesh/network-profiles) or local packages.
Expand Down
8 changes: 4 additions & 4 deletions collections/_projects/libremesh-cable-purpose-autodection.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ tags:

When a community network router ethernet port is acting as a gateway to the
Internet or as a border to neighboring networks, the network configuration
usually needs to be changed from the default settings to accomodate for the
usually needs to be changed from the default settings to accommodate for the
specific role.
A router ethernet port can be connected to the Internet, or connected to a dummy
wifi device for a point to point link, or connected to another router of the
same mesh network to expand mesh coverage.
All these cases would benefit of specific configuration. As of today handling
those configuration manually represents a barrier for communities without
technical experts who could understand and optimize the devices ethernet ports
configuration appropiately.
configuration appropriately.
Most of the described situation could be detected at runtime through automatic
tests and the required configuration applied automatically, the goal of this
project is to develop the software needed to accomplish automatically to the
Expand All @@ -49,11 +49,11 @@ described needs.

##### GSoC Community Bonding

* The contributor should enumerate all ethernet cable setups that migh be needed.
* The contributor should enumerate all ethernet cable setups that might be needed.
* The contributor must have a LibreMesh repository fork.
* The contributor must learn how to contribute code via merge request mechanism.
* The contributor should relate comfortably with the LibreMesh developers.
* The contributor should individuate one or more real world comminity network and establish a fluid cooperation relationship with them.
* The contributor should individuate one or more real world community network and establish a fluid cooperation relationship with them.


##### GSOC Midterm
Expand Down
6 changes: 3 additions & 3 deletions collections/_projects/libremesh-mesh-beacons.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: "Mesh beacons: low bitrate communication in disconnected mesh radios"
desc: "Provide a mechanism for mesh nodes to exchange (more) information with their peers without the need to be associated (scanning only). This has many usefull use cases, from knowing the name of the node before connecting, to aiding antenna alignment with low quality signal, etc."
desc: "Provide a mechanism for mesh nodes to exchange (more) information with their peers without the need to be associated (scanning only). This has many useful use cases, from knowing the name of the node before connecting, to aiding antenna alignment with low quality signal, etc."
requirements:
- "The applicant needs to have an understanding of low level programming."
difficulty: medium
Expand All @@ -25,8 +25,8 @@ collaborating_projects:
---

Exchanging information between disconnected 802.11s peers is important because connection takes a lot of time and/or the signal quality is not enough to reliably connect but is enough to send/receive some packets.
In OpenWrt 802.11s implementation there is no known easy way to add and retrieve information in the beacons albeit the specification of 802.11s provides ways of adding custom information.
The contributor will have to study the Linux kernel implementation of 802.11s to double check if Linux provides a way to add information to the baeacons and also a way to retrieve this custom information.
In OpenWrt 802.11s implementation there is no known easy way to add and retrieve information in the beacons albeit the specification of 802.11s provides ways of adding custom information.
The contributor will have to study the Linux kernel implementation of 802.11s to double check if Linux provides a way to add information to the beacons and also a way to retrieve this custom information.

If there is no support in Linux then the project can take two paths:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ tags:
To contribute to LibreMesh most of the time one have to create a new module that
is usually shipped as an OpenWrt package. People that have been joining
LibreMesh development over time have been encountering a steep learning curve
expecially packaging their modules, because of the complexity of OpenWrt
especially packaging their modules, because of the complexity of OpenWrt
build-root. Those packages most of the time consists just of a couple of Lua or
shell scripts that doesn't need cross-compiling and other advanced features
provided by OpenWrt build-root.
Expand Down
6 changes: 3 additions & 3 deletions collections/_projects/libremesh-pirania-traffic-shaping.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: "Implement traffic priorization in Pirania captive portal for mesh networks"
name: "Implement traffic prioritization in Pirania captive portal for mesh networks"
desc: "Pirania captive portal is a voucher-based captive portal used in LibreMesh. In order to have guest access, this should have a lower priority, managed via Traffic Control."
requirements:
- "The applicant needs to have understanding of networking in mesh networks."
Expand All @@ -25,9 +25,9 @@ collaborating_projects:

Pirania captive portal is already in production in some community networks running LibreMesh on their routers.
The usage of Pirania helps the community to pay the bill from the internet service provider.
But LibreMesh project also tries to open the access to the local and remote digital resources to everyone, and for this reason the availability of a guest access would be reccomended.
But LibreMesh project also tries to open the access to the local and remote digital resources to everyone, and for this reason the availability of a guest access would be recommended.
This will require that the presence of a connected guest client does not slow down the connection of the owner of the gateway or of who actually paid for having a Pirania voucher.
In order to achieve this, the data packets needs to have different priorities depending on the originating client, diregard the mesh node (access point) this client is connected to.
In order to achieve this, the data packets needs to have different priorities depending on the originating client, disregard the mesh node (access point) this client is connected to.
The problem is absolutely non-trivial, and the technical tools needed will be at least Traffic Control, Smart Queue Management, and iptables.

#### Milestones
Expand Down
2 changes: 1 addition & 1 deletion collections/_projects/olsrd_build_and_release_system.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ tags:
- testing
---

The Optimized Link State Routing Protocol (`OLSR`) is an IP routing protocol optimized for mobile ad hoc networks, which can also be used on other wireless ad hoc networks.
The Optimized Link State Routing Protocol (`OLSR`) is an IP routing protocol optimized for mobile ad hoc networks, which can also be used on other wireless ad hoc networks.

`OLSR` was one of the first protocols created nearly 20 years ago. For some use cases, it's still a reliable and stable protocol and is still used in several wireless network communities.

Expand Down
6 changes: 3 additions & 3 deletions collections/_projects/openwrt_migrate_luci.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ developers_involved:
- jow
- aparcar
difficulty: medium
status: completed
status: completed
initiatives:
- GSoC
- GSoC2023
Expand All @@ -29,9 +29,9 @@ tags:
- configuration
---

`OpenWrt` is a distribution for embedded devices such as WiFi router etc. `LuCI` is a framework to build a web interface for configuration and monitoing.
`OpenWrt` is a distribution for embedded devices such as WiFi router etc. `LuCI` is a framework to build a web interface for configuration and monitoring.

With the old system all pages are rendered on the router delivering html to the browser. This leads to a higher load on the embedded devices. To reduce this load, rendering should be outsoruced to the browser. The framework LuCI itself is already prepared for this and provides a client side API.
With the old system all pages are rendered on the router delivering html to the browser. This leads to a higher load on the embedded devices. To reduce this load, rendering should be outsourced to the browser. The framework LuCI itself is already prepared for this and provides a client side API.

Data will be provided via rpcd and ubus in a JSON format. You probably have to write new rpcd services to provide data that was formerly used directly on the router. Services are usually written as ash script.

Expand Down
2 changes: 1 addition & 1 deletion collections/_projects/openwrt_ppa.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ collaborating_projects:
desc: "Extend the openwrt PPA, or Personal Package Archive"
developers_involved: [ ]
difficulty: medium
status: completed
status: completed
size: "175 hours"
initiatives:
- GSoC
Expand Down
4 changes: 2 additions & 2 deletions collections/_projects/qaul-linux-ble-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: "qaul BLE Module for Linux with BlueR"
desc: "Create a Linux BLE (Bluetooth Low Energy) module which compatible to the two existing modules for Android & iOS."
collaborating_projects:
- qaul
developers_involved:
developers_involved:
- MathJud
difficulty: medium
size: "350 hours"
Expand Down Expand Up @@ -47,7 +47,7 @@ It shall do the following things:

The module is independent and will communicate via protobuf to the controlling backend library libqaul.

`BlueR` is the official Bluetooth low energy repository for for rust.
`BlueR` is the official Bluetooth low energy repository for rust.
<https://github.com/bluez/bluer>

Prototypes with partial functionality already exist.
Expand Down
4 changes: 2 additions & 2 deletions collections/_projects/qaul-matrix-bridge.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: "qaul Matrix Bridge"
desc: "Create a matrix bridge for the qaul messenger App"
collaborating_projects:
- qaul
developers_involved:
developers_involved:
- MathJud
- Saces
difficulty: medium
Expand Down Expand Up @@ -64,7 +64,7 @@ qaul is written in rust, uses rust-libp2p internally and has a cross platform fl

* create a concept for your project (application phase)
* create a detailed concept for the relay bridge
* implement the releay bridge
* implement the relay bridge
* implement the libqaul part in rust
* create a golang matrix communication part
* create a detailed concept for double-puppeting
Expand Down
2 changes: 1 addition & 1 deletion collections/_projects/qaul-user-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: "qaul RPC user authentication layer"
desc: "libqaul <-> GUI protobuf RPC authentication"
collaborating_projects:
- qaul
developers_involved:
developers_involved:
- MathJud
difficulty: medium
size: "350 hours"
Expand Down
Loading

0 comments on commit 1b613c6

Please sign in to comment.