From 0f8615abe1446d4e337aeec6f77c850d3dd5f9a3 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Wed, 20 Dec 2017 12:45:58 +0000 Subject: [PATCH] CoC documentation on website --- doc/EN/codeofconduct.org | 49 +++++ doc/EN/devguide.org | 15 +- doc/EN/index.org | 2 +- website/EN/codeofconduct.html | 348 ++++++++++++++++++++++++++++++++++ website/EN/devguide.html | 65 +++---- website/EN/index.html | 4 +- 6 files changed, 423 insertions(+), 60 deletions(-) create mode 100644 doc/EN/codeofconduct.org create mode 100644 website/EN/codeofconduct.html diff --git a/doc/EN/codeofconduct.org b/doc/EN/codeofconduct.org new file mode 100644 index 00000000..6d9aecb9 --- /dev/null +++ b/doc/EN/codeofconduct.org @@ -0,0 +1,49 @@ +#+TITLE: +#+AUTHOR: Bob Mottram +#+EMAIL: bob@freedombone.net +#+KEYWORDS: freedombone, code of conduct +#+DESCRIPTION: Code of Conduct for the Freedombone project +#+OPTIONS: ^:nil toc:nil +#+HTML_HEAD: + +#+BEGIN_CENTER +[[file:images/logo.png]] +#+END_CENTER + +#+begin_export html +

Code of Conduct

+#+end_export + +* Be respectful + +In any Free Software project with more than one participant inevitably there may be people with whom you may disagree, or find it difficult to cooperate. Accept that, but even so, remain respectful. Disagreement is no excuse for poor behaviour or personal attacks, and a community in which people feel threatened is not a healthy community. + +* Assume good faith + +Freedombone Contributors have many ways of reaching our common goal of providing freedom respecting internet or mesh systems which may differ from your ways. Assume that other people are working towards this goal. + +* Be collaborative + +Freedombone is a moderately complex project, though nothing big and professional like GNU. It's good to ask for help when you need it. Similarly, offers for help should be seen in the context of our shared goal of improving the system. + +When you make something for the benefit of the project, be willing to explain to others how it works, so that they can build on your work to make it even better. + +* Try to be concise + +If you're submitting documentation then keep in mind that what you write once could be read by many other people. To avoid TL;DR keep it as short and concise as possible. This will also reduce the amount of translations effort needed. + +If you're discussing an issue or bug, try to stay on topic, especially in discussions that are already fairly large. + +* Be open + +Most ways of communication used within Freedombone (eg Matrix/XMPP) allow for public and private communication. Prefer public methods of communication for Freedombone-related messages, unless posting something sensitive. + +This applies to messages for help, too; not only is a public support request much more likely to result in an answer to your question, it also makes sure that any inadvertent mistakes made by people answering your question will be more easily detected and corrected. + +* In case of problems + +While this code of conduct should be adhered to by participants, we recognize that sometimes people may have a bad day, or be unaware of some of the guidelines in this code of conduct. When that happens, you may reply to them and point out this code of conduct. Such messages may be in public or in private, whatever is most appropriate. However, regardless of whether the message is public or not, it should still adhere to the relevant parts of this code of conduct; in particular, it should not be abusive or disrespectful. Assume good faith; it is more likely that participants are unaware of their bad behaviour than that they intentionally try to degrade the quality of the discussion. + +Serious or persistent offenders will be kicked from chat rooms and any of their subsequent patches will be unlikely to be upstreamed. + +Complaints should be made (in private) to the maintainer or chat room admin. The typical email address can be found in the source code headers. Preferably use GPG/OpenPGP if you can, or XMPP with OTR/OMEMO to bob@freedombone.net. diff --git a/doc/EN/devguide.org b/doc/EN/devguide.org index 14c92479..e47876e5 100644 --- a/doc/EN/devguide.org +++ b/doc/EN/devguide.org @@ -15,20 +15,7 @@ #+end_export * Introduction -Freedombone consists of a set of bash scripts. There are a lot of them, but they're not very complicated. If you're familiar with the GNU/Linux commandline and can hack a bash script then you can probably add a new app or fix a bug in the system. There are no trendy development frameworks to learn or to get in your way. -* Substitute for a Code of Conduct -Instead of having some tedious /Code of Conduct/ which tries to micro-manage how folks communicate privately with each other this project has a set of guiding principles, which are as follows: - - * Enable users to help themselves to provide their own personal software infrastructure. - * Enable users to help each other to provide software infrastructure for a community. - * Principle of self-management: apps should require miniumum configuration and maintain themselves as far as possible. - * There should be no single point of failure. Assume that other servers can and will fail occasionally. - * Minimum data retention. Only store the data which users actually want or need, and within apps implement the function which allows logging to be turned off. - * Respect other users right to run their own stuff and have their own policies on their own hardware. - * Remove as many intermediating organisations as possible. For example, Google tracking embedded within some Free Software apps. - * No tollbooths, rent-seeking, gatekeepers or paywalls. - * Maximize energy efficiency. No systems which fundamentally depend upon proof-of-work block solving or other compute-heavy methods. The target here is small single board computers. - +Freedombone consists of a set of bash scripts. There are a lot of them, but they're not very complicated. If you're familiar with the GNU/Linux commandline and can hack a bash script then you can probably add a new app or fix a bug in the system. There are no trendy development frameworks to learn or to get in your way. You might also want to consult the [[./codeofconduct.html][Code of Conduct]]. * Adding extra apps Suppose you have some internet application which you want to add to the system. To do this you need to create an app script which tells the system how to install/remove and also backup/restore. The script should be designed to work with the current stable version of Debian. diff --git a/doc/EN/index.org b/doc/EN/index.org index f6acd019..6b708911 100644 --- a/doc/EN/index.org +++ b/doc/EN/index.org @@ -37,7 +37,7 @@ After installation it's possible that you might want some advice on how to run y * [[./faq.html][Frequently Asked Questions]] * [[./mobile.html][Advice on setting up a mobile phone]] -If you find bugs, or want to add a new app to this system see the [[./devguide.html][Developers Guide]]. +If you find bugs, or want to add a new app to this system see the [[./devguide.html][Developers Guide]] and [[./codeofconduct.html][Code of Conduct]]. Ready made disk images which can be copied onto USB or microSD drives are [[./downloads/current][available here]]. diff --git a/website/EN/codeofconduct.html b/website/EN/codeofconduct.html new file mode 100644 index 00000000..3a022ff9 --- /dev/null +++ b/website/EN/codeofconduct.html @@ -0,0 +1,348 @@ + + + + + + + +‎ + + + + + + + + + +
+ +
+
+
+ +
+

logo.png +

+
+
+ +

Code of Conduct

+ +
+

Be respectful

+
+

+In any Free Software project with more than one participant inevitably there may be people with whom you may disagree, or find it difficult to cooperate. Accept that, but even so, remain respectful. Disagreement is no excuse for poor behaviour or personal attacks, and a community in which people feel threatened is not a healthy community. +

+
+
+ +
+

Assume good faith

+
+

+Freedombone Contributors have many ways of reaching our common goal of providing freedom respecting internet or mesh systems which may differ from your ways. Assume that other people are working towards this goal. +

+
+
+ +
+

Be collaborative

+
+

+Freedombone is a moderately complex project, though nothing big and professional like GNU. It's good to ask for help when you need it. Similarly, offers for help should be seen in the context of our shared goal of improving the system. +

+ +

+When you make something for the benefit of the project, be willing to explain to others how it works, so that they can build on your work to make it even better. +

+
+
+ +
+

Try to be concise

+
+

+If you're submitting documentation then keep in mind that what you write once could be read by many other people. To avoid TL;DR keep it as short and concise as possible. This will also reduce the amount of translations effort needed. +

+ +

+If you're discussing an issue or bug, try to stay on topic, especially in discussions that are already fairly large. +

+
+
+ +
+

Be open

+
+

+Most ways of communication used within Freedombone (eg Matrix/XMPP) allow for public and private communication. Prefer public methods of communication for Freedombone-related messages, unless posting something sensitive. +

+ +

+This applies to messages for help, too; not only is a public support request much more likely to result in an answer to your question, it also makes sure that any inadvertent mistakes made by people answering your question will be more easily detected and corrected. +

+
+
+ +
+

In case of problems

+
+

+While this code of conduct should be adhered to by participants, we recognize that sometimes people may have a bad day, or be unaware of some of the guidelines in this code of conduct. When that happens, you may reply to them and point out this code of conduct. Such messages may be in public or in private, whatever is most appropriate. However, regardless of whether the message is public or not, it should still adhere to the relevant parts of this code of conduct; in particular, it should not be abusive or disrespectful. Assume good faith; it is more likely that participants are unaware of their bad behaviour than that they intentionally try to degrade the quality of the discussion. +

+ +

+Serious or persistent offenders will be kicked from chat rooms and any of their subsequent patches will be unlikely to be upstreamed. +

+ +

+Complaints should be made (in private) to the maintainer or chat room admin. The typical email address can be found in the source code headers. Preferably use GPG/OpenPGP if you can, or XMPP with OTR/OMEMO to bob@freedombone.net. +

+
+
+
+
+ + + +
+Back to top | E-mail me +
+
+ + diff --git a/website/EN/devguide.html b/website/EN/devguide.html index c6077ad7..d4287c8a 100644 --- a/website/EN/devguide.html +++ b/website/EN/devguide.html @@ -3,10 +3,10 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + - +‎

Developers Guide

-
-

Introduction

-
+
+

Introduction

+

-Freedombone consists of a set of bash scripts. There are a lot of them, but they're not very complicated. If you're familiar with the GNU/Linux commandline and can hack a bash script then you can probably add a new app or fix a bug in the system. There are no trendy development frameworks to learn or to get in your way. +Freedombone consists of a set of bash scripts. There are a lot of them, but they're not very complicated. If you're familiar with the GNU/Linux commandline and can hack a bash script then you can probably add a new app or fix a bug in the system. There are no trendy development frameworks to learn or to get in your way. You might also want to consult the Code of Conduct.

-
-

Substitute for a Code of Conduct

-
-

-Instead of having some tedious Code of Conduct which tries to micro-manage how folks communicate privately with each other this project has a set of guiding principles, which are as follows: -

- -
    -
  • Enable users to help themselves to provide their own personal software infrastructure.
    • -
  • Enable users to help each other to provide software infrastructure for a community.
    • -
  • Principle of self-management: apps should require miniumum configuration and maintain themselves as far as possible.
    • -
  • There should be no single point of failure. Assume that other servers can and will fail occasionally.
    • -
  • Minimum data retention. Only store the data which users actually want or need, and within apps implement the function which allows logging to be turned off.
    • -
  • Respect other users right to run their own stuff and have their own policies on their own hardware.
    • -
  • Remove as many intermediating organisations as possible. For example, Google tracking embedded within some Free Software apps.
    • -
  • No tollbooths, rent-seeking, gatekeepers or paywalls.
    • -
  • Maximize energy efficiency. No systems which fundamentally depend upon proof-of-work block solving or other compute-heavy methods. The target here is small single board computers.
    • -
-
-
- -
-

Adding extra apps

-
+
+

Adding extra apps

+

Suppose you have some internet application which you want to add to the system. To do this you need to create an app script which tells the system how to install/remove and also backup/restore. The script should be designed to work with the current stable version of Debian.

@@ -287,8 +266,8 @@ On an installed system the app scripts go into the directory:

-
/usr/share/freedombone/apps
-
+
/usr/share/freedombone/apps
+

@@ -296,8 +275,8 @@ and within the project repo they appear within the src directory. Your ne

-
freedombone-app-[myappname]
-
+
freedombone-app-[myappname]
+

@@ -309,7 +288,7 @@ An example template for an app script is shown below. Copy this and add whatever

-
#!/bin/bash
+
#!/bin/bash
 # Copyright (C) Year YourName <YourEmail>
 #
 # This program is free software: you can redistribute it
@@ -520,7 +499,7 @@ An example template for an app script is shown below. Copy this and add whatever
 }
 
 # NOTE: deliberately no exit 0
-

+

@@ -528,8 +507,8 @@ To test your app log into your system, select Exit to command line then g

-
sudo su
-
+
sudo su
+

@@ -541,8 +520,8 @@ And run the admin control panel:

-
control
-
+
control
+

@@ -555,9 +534,9 @@ Submit your working app to -

Customising mesh images

-
+