Browse Source

CoC documentation on website

Bob Mottram 7 years ago
parent
commit
0f8615abe1
6 changed files with 423 additions and 60 deletions
  1. 49
    0
      doc/EN/codeofconduct.org
  2. 1
    14
      doc/EN/devguide.org
  3. 1
    1
      doc/EN/index.org
  4. 348
    0
      website/EN/codeofconduct.html
  5. 22
    43
      website/EN/devguide.html
  6. 2
    2
      website/EN/index.html

+ 49
- 0
doc/EN/codeofconduct.org View File

@@ -0,0 +1,49 @@
1
+#+TITLE:
2
+#+AUTHOR: Bob Mottram
3
+#+EMAIL: bob@freedombone.net
4
+#+KEYWORDS: freedombone, code of conduct
5
+#+DESCRIPTION: Code of Conduct for the Freedombone project
6
+#+OPTIONS: ^:nil toc:nil
7
+#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="freedombone.css" />
8
+
9
+#+BEGIN_CENTER
10
+[[file:images/logo.png]]
11
+#+END_CENTER
12
+
13
+#+begin_export html
14
+<center><h1>Code of Conduct</h1></center>
15
+#+end_export
16
+
17
+* Be respectful
18
+
19
+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.
20
+
21
+* Assume good faith
22
+
23
+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.
24
+
25
+* Be collaborative
26
+
27
+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.
28
+
29
+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.
30
+
31
+* Try to be concise
32
+
33
+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.
34
+
35
+If you're discussing an issue or bug, try to stay on topic, especially in discussions that are already fairly large.
36
+
37
+* Be open
38
+
39
+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.
40
+
41
+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.
42
+
43
+* In case of problems
44
+
45
+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.
46
+
47
+Serious or persistent offenders will be kicked from chat rooms and any of their subsequent patches will be unlikely to be upstreamed.
48
+
49
+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.

+ 1
- 14
doc/EN/devguide.org View File

@@ -15,20 +15,7 @@
15 15
 #+end_export
16 16
 
17 17
 * Introduction
18
-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.
19
-* Substitute for a Code of Conduct
20
-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:
21
-
22
- * Enable users to help themselves to provide their own personal software infrastructure.
23
- * Enable users to help each other to provide software infrastructure for a community.
24
- * Principle of self-management: apps should require miniumum configuration and maintain themselves as far as possible.
25
- * There should be no single point of failure. Assume that other servers can and will fail occasionally.
26
- * 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.
27
- * Respect other users right to run their own stuff and have their own policies on their own hardware.
28
- * Remove as many intermediating organisations as possible. For example, Google tracking embedded within some Free Software apps.
29
- * No tollbooths, rent-seeking, gatekeepers or paywalls.
30
- * 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.
31
-
18
+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]].
32 19
 * Adding extra apps
33 20
 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.
34 21
 

+ 1
- 1
doc/EN/index.org View File

@@ -37,7 +37,7 @@ After installation it's possible that you might want some advice on how to run y
37 37
  * [[./faq.html][Frequently Asked Questions]]
38 38
  * [[./mobile.html][Advice on setting up a mobile phone]]
39 39
 
40
-If you find bugs, or want to add a new app to this system see the [[./devguide.html][Developers Guide]].
40
+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]].
41 41
 
42 42
 Ready made disk images which can be copied onto USB or microSD drives are [[./downloads/current][available here]].
43 43
 

+ 348
- 0
website/EN/codeofconduct.html View File

@@ -0,0 +1,348 @@
1
+<?xml version="1.0" encoding="utf-8"?>
2
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5
+<head>
6
+<!-- 2017-12-20 Wed 12:45 -->
7
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
8
+<meta name="viewport" content="width=device-width, initial-scale=1" />
9
+<title>&lrm;</title>
10
+<meta name="generator" content="Org mode" />
11
+<meta name="author" content="Bob Mottram" />
12
+<meta name="description" content="Code of Conduct for the Freedombone project"
13
+ />
14
+<meta name="keywords" content="freedombone, code of conduct" />
15
+<style type="text/css">
16
+ <!--/*--><![CDATA[/*><!--*/
17
+  .title  { text-align: center;
18
+             margin-bottom: .2em; }
19
+  .subtitle { text-align: center;
20
+              font-size: medium;
21
+              font-weight: bold;
22
+              margin-top:0; }
23
+  .todo   { font-family: monospace; color: red; }
24
+  .done   { font-family: monospace; color: green; }
25
+  .priority { font-family: monospace; color: orange; }
26
+  .tag    { background-color: #eee; font-family: monospace;
27
+            padding: 2px; font-size: 80%; font-weight: normal; }
28
+  .timestamp { color: #bebebe; }
29
+  .timestamp-kwd { color: #5f9ea0; }
30
+  .org-right  { margin-left: auto; margin-right: 0px;  text-align: right; }
31
+  .org-left   { margin-left: 0px;  margin-right: auto; text-align: left; }
32
+  .org-center { margin-left: auto; margin-right: auto; text-align: center; }
33
+  .underline { text-decoration: underline; }
34
+  #postamble p, #preamble p { font-size: 90%; margin: .2em; }
35
+  p.verse { margin-left: 3%; }
36
+  pre {
37
+    border: 1px solid #ccc;
38
+    box-shadow: 3px 3px 3px #eee;
39
+    padding: 8pt;
40
+    font-family: monospace;
41
+    overflow: auto;
42
+    margin: 1.2em;
43
+  }
44
+  pre.src {
45
+    position: relative;
46
+    overflow: visible;
47
+    padding-top: 1.2em;
48
+  }
49
+  pre.src:before {
50
+    display: none;
51
+    position: absolute;
52
+    background-color: white;
53
+    top: -10px;
54
+    right: 10px;
55
+    padding: 3px;
56
+    border: 1px solid black;
57
+  }
58
+  pre.src:hover:before { display: inline;}
59
+  /* Languages per Org manual */
60
+  pre.src-asymptote:before { content: 'Asymptote'; }
61
+  pre.src-awk:before { content: 'Awk'; }
62
+  pre.src-C:before { content: 'C'; }
63
+  /* pre.src-C++ doesn't work in CSS */
64
+  pre.src-clojure:before { content: 'Clojure'; }
65
+  pre.src-css:before { content: 'CSS'; }
66
+  pre.src-D:before { content: 'D'; }
67
+  pre.src-ditaa:before { content: 'ditaa'; }
68
+  pre.src-dot:before { content: 'Graphviz'; }
69
+  pre.src-calc:before { content: 'Emacs Calc'; }
70
+  pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
71
+  pre.src-fortran:before { content: 'Fortran'; }
72
+  pre.src-gnuplot:before { content: 'gnuplot'; }
73
+  pre.src-haskell:before { content: 'Haskell'; }
74
+  pre.src-hledger:before { content: 'hledger'; }
75
+  pre.src-java:before { content: 'Java'; }
76
+  pre.src-js:before { content: 'Javascript'; }
77
+  pre.src-latex:before { content: 'LaTeX'; }
78
+  pre.src-ledger:before { content: 'Ledger'; }
79
+  pre.src-lisp:before { content: 'Lisp'; }
80
+  pre.src-lilypond:before { content: 'Lilypond'; }
81
+  pre.src-lua:before { content: 'Lua'; }
82
+  pre.src-matlab:before { content: 'MATLAB'; }
83
+  pre.src-mscgen:before { content: 'Mscgen'; }
84
+  pre.src-ocaml:before { content: 'Objective Caml'; }
85
+  pre.src-octave:before { content: 'Octave'; }
86
+  pre.src-org:before { content: 'Org mode'; }
87
+  pre.src-oz:before { content: 'OZ'; }
88
+  pre.src-plantuml:before { content: 'Plantuml'; }
89
+  pre.src-processing:before { content: 'Processing.js'; }
90
+  pre.src-python:before { content: 'Python'; }
91
+  pre.src-R:before { content: 'R'; }
92
+  pre.src-ruby:before { content: 'Ruby'; }
93
+  pre.src-sass:before { content: 'Sass'; }
94
+  pre.src-scheme:before { content: 'Scheme'; }
95
+  pre.src-screen:before { content: 'Gnu Screen'; }
96
+  pre.src-sed:before { content: 'Sed'; }
97
+  pre.src-sh:before { content: 'shell'; }
98
+  pre.src-sql:before { content: 'SQL'; }
99
+  pre.src-sqlite:before { content: 'SQLite'; }
100
+  /* additional languages in org.el's org-babel-load-languages alist */
101
+  pre.src-forth:before { content: 'Forth'; }
102
+  pre.src-io:before { content: 'IO'; }
103
+  pre.src-J:before { content: 'J'; }
104
+  pre.src-makefile:before { content: 'Makefile'; }
105
+  pre.src-maxima:before { content: 'Maxima'; }
106
+  pre.src-perl:before { content: 'Perl'; }
107
+  pre.src-picolisp:before { content: 'Pico Lisp'; }
108
+  pre.src-scala:before { content: 'Scala'; }
109
+  pre.src-shell:before { content: 'Shell Script'; }
110
+  pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
111
+  /* additional language identifiers per "defun org-babel-execute"
112
+       in ob-*.el */
113
+  pre.src-cpp:before  { content: 'C++'; }
114
+  pre.src-abc:before  { content: 'ABC'; }
115
+  pre.src-coq:before  { content: 'Coq'; }
116
+  pre.src-groovy:before  { content: 'Groovy'; }
117
+  /* additional language identifiers from org-babel-shell-names in
118
+     ob-shell.el: ob-shell is the only babel language using a lambda to put
119
+     the execution function name together. */
120
+  pre.src-bash:before  { content: 'bash'; }
121
+  pre.src-csh:before  { content: 'csh'; }
122
+  pre.src-ash:before  { content: 'ash'; }
123
+  pre.src-dash:before  { content: 'dash'; }
124
+  pre.src-ksh:before  { content: 'ksh'; }
125
+  pre.src-mksh:before  { content: 'mksh'; }
126
+  pre.src-posh:before  { content: 'posh'; }
127
+  /* Additional Emacs modes also supported by the LaTeX listings package */
128
+  pre.src-ada:before { content: 'Ada'; }
129
+  pre.src-asm:before { content: 'Assembler'; }
130
+  pre.src-caml:before { content: 'Caml'; }
131
+  pre.src-delphi:before { content: 'Delphi'; }
132
+  pre.src-html:before { content: 'HTML'; }
133
+  pre.src-idl:before { content: 'IDL'; }
134
+  pre.src-mercury:before { content: 'Mercury'; }
135
+  pre.src-metapost:before { content: 'MetaPost'; }
136
+  pre.src-modula-2:before { content: 'Modula-2'; }
137
+  pre.src-pascal:before { content: 'Pascal'; }
138
+  pre.src-ps:before { content: 'PostScript'; }
139
+  pre.src-prolog:before { content: 'Prolog'; }
140
+  pre.src-simula:before { content: 'Simula'; }
141
+  pre.src-tcl:before { content: 'tcl'; }
142
+  pre.src-tex:before { content: 'TeX'; }
143
+  pre.src-plain-tex:before { content: 'Plain TeX'; }
144
+  pre.src-verilog:before { content: 'Verilog'; }
145
+  pre.src-vhdl:before { content: 'VHDL'; }
146
+  pre.src-xml:before { content: 'XML'; }
147
+  pre.src-nxml:before { content: 'XML'; }
148
+  /* add a generic configuration mode; LaTeX export needs an additional
149
+     (add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
150
+  pre.src-conf:before { content: 'Configuration File'; }
151
+
152
+  table { border-collapse:collapse; }
153
+  caption.t-above { caption-side: top; }
154
+  caption.t-bottom { caption-side: bottom; }
155
+  td, th { vertical-align:top;  }
156
+  th.org-right  { text-align: center;  }
157
+  th.org-left   { text-align: center;   }
158
+  th.org-center { text-align: center; }
159
+  td.org-right  { text-align: right;  }
160
+  td.org-left   { text-align: left;   }
161
+  td.org-center { text-align: center; }
162
+  dt { font-weight: bold; }
163
+  .footpara { display: inline; }
164
+  .footdef  { margin-bottom: 1em; }
165
+  .figure { padding: 1em; }
166
+  .figure p { text-align: center; }
167
+  .inlinetask {
168
+    padding: 10px;
169
+    border: 2px solid gray;
170
+    margin: 10px;
171
+    background: #ffffcc;
172
+  }
173
+  #org-div-home-and-up
174
+   { text-align: right; font-size: 70%; white-space: nowrap; }
175
+  textarea { overflow-x: auto; }
176
+  .linenr { font-size: smaller }
177
+  .code-highlighted { background-color: #ffff00; }
178
+  .org-info-js_info-navigation { border-style: none; }
179
+  #org-info-js_console-label
180
+    { font-size: 10px; font-weight: bold; white-space: nowrap; }
181
+  .org-info-js_search-highlight
182
+    { background-color: #ffff00; color: #000000; font-weight: bold; }
183
+  .org-svg { width: 90%; }
184
+  /*]]>*/-->
185
+</style>
186
+<link rel="stylesheet" type="text/css" href="freedombone.css" />
187
+<script type="text/javascript">
188
+/*
189
+@licstart  The following is the entire license notice for the
190
+JavaScript code in this tag.
191
+
192
+Copyright (C) 2012-2017 Free Software Foundation, Inc.
193
+
194
+The JavaScript code in this tag is free software: you can
195
+redistribute it and/or modify it under the terms of the GNU
196
+General Public License (GNU GPL) as published by the Free Software
197
+Foundation, either version 3 of the License, or (at your option)
198
+any later version.  The code is distributed WITHOUT ANY WARRANTY;
199
+without even the implied warranty of MERCHANTABILITY or FITNESS
200
+FOR A PARTICULAR PURPOSE.  See the GNU GPL for more details.
201
+
202
+As additional permission under GNU GPL version 3 section 7, you
203
+may distribute non-source (e.g., minimized or compacted) forms of
204
+that code without the copy of the GNU GPL normally required by
205
+section 4, provided you include this license notice and a URL
206
+through which recipients can access the Corresponding Source.
207
+
208
+
209
+@licend  The above is the entire license notice
210
+for the JavaScript code in this tag.
211
+*/
212
+<!--/*--><![CDATA[/*><!--*/
213
+ function CodeHighlightOn(elem, id)
214
+ {
215
+   var target = document.getElementById(id);
216
+   if(null != target) {
217
+     elem.cacheClassElem = elem.className;
218
+     elem.cacheClassTarget = target.className;
219
+     target.className = "code-highlighted";
220
+     elem.className   = "code-highlighted";
221
+   }
222
+ }
223
+ function CodeHighlightOff(elem, id)
224
+ {
225
+   var target = document.getElementById(id);
226
+   if(elem.cacheClassElem)
227
+     elem.className = elem.cacheClassElem;
228
+   if(elem.cacheClassTarget)
229
+     target.className = elem.cacheClassTarget;
230
+ }
231
+/*]]>*///-->
232
+</script>
233
+</head>
234
+<body>
235
+<div id="preamble" class="status">
236
+<a name="top" id="top"></a>
237
+</div>
238
+<div id="content">
239
+<div class="org-center">
240
+
241
+<div class="figure">
242
+<p><img src="images/logo.png" alt="logo.png" />
243
+</p>
244
+</div>
245
+</div>
246
+
247
+<center><h1>Code of Conduct</h1></center>
248
+
249
+<div id="outline-container-orga839710" class="outline-2">
250
+<h2 id="orga839710">Be respectful</h2>
251
+<div class="outline-text-2" id="text-orga839710">
252
+<p>
253
+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.
254
+</p>
255
+</div>
256
+</div>
257
+
258
+<div id="outline-container-org890f143" class="outline-2">
259
+<h2 id="org890f143">Assume good faith</h2>
260
+<div class="outline-text-2" id="text-org890f143">
261
+<p>
262
+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.
263
+</p>
264
+</div>
265
+</div>
266
+
267
+<div id="outline-container-orgccafefb" class="outline-2">
268
+<h2 id="orgccafefb">Be collaborative</h2>
269
+<div class="outline-text-2" id="text-orgccafefb">
270
+<p>
271
+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.
272
+</p>
273
+
274
+<p>
275
+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.
276
+</p>
277
+</div>
278
+</div>
279
+
280
+<div id="outline-container-org960241b" class="outline-2">
281
+<h2 id="org960241b">Try to be concise</h2>
282
+<div class="outline-text-2" id="text-org960241b">
283
+<p>
284
+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.
285
+</p>
286
+
287
+<p>
288
+If you're discussing an issue or bug, try to stay on topic, especially in discussions that are already fairly large.
289
+</p>
290
+</div>
291
+</div>
292
+
293
+<div id="outline-container-orgd3249bd" class="outline-2">
294
+<h2 id="orgd3249bd">Be open</h2>
295
+<div class="outline-text-2" id="text-orgd3249bd">
296
+<p>
297
+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.
298
+</p>
299
+
300
+<p>
301
+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.
302
+</p>
303
+</div>
304
+</div>
305
+
306
+<div id="outline-container-org8f9612f" class="outline-2">
307
+<h2 id="org8f9612f">In case of problems</h2>
308
+<div class="outline-text-2" id="text-org8f9612f">
309
+<p>
310
+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.
311
+</p>
312
+
313
+<p>
314
+Serious or persistent offenders will be kicked from chat rooms and any of their subsequent patches will be unlikely to be upstreamed.
315
+</p>
316
+
317
+<p>
318
+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.
319
+</p>
320
+</div>
321
+</div>
322
+</div>
323
+<div id="postamble" class="status">
324
+
325
+<style type="text/css">
326
+.back-to-top {
327
+    position: fixed;
328
+    bottom: 2em;
329
+    right: 0px;
330
+    text-decoration: none;
331
+    color: #000000;
332
+    background-color: rgba(235, 235, 235, 0.80);
333
+    font-size: 12px;
334
+    padding: 1em;
335
+    display: none;
336
+}
337
+
338
+.back-to-top:hover {
339
+    background-color: rgba(135, 135, 135, 0.50);
340
+}
341
+</style>
342
+
343
+<div class="back-to-top">
344
+<a href="#top">Back to top</a> | <a href="mailto:bob@freedombone.net">E-mail me</a>
345
+</div>
346
+</div>
347
+</body>
348
+</html>

+ 22
- 43
website/EN/devguide.html View File

@@ -3,10 +3,10 @@
3 3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5 5
 <head>
6
-<!-- 2017-07-18 Tue 11:19 -->
6
+<!-- 2017-12-20 Wed 12:42 -->
7 7
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
8 8
 <meta name="viewport" content="width=device-width, initial-scale=1" />
9
-<title></title>
9
+<title>&lrm;</title>
10 10
 <meta name="generator" content="Org mode" />
11 11
 <meta name="author" content="Bob Mottram" />
12 12
 <meta name="description" content="Turn the Beaglebone Black into a personal communications server"
@@ -246,38 +246,17 @@ for the JavaScript code in this tag.
246 246
 
247 247
 <center><h1>Developers Guide</h1></center>
248 248
 
249
-<div id="outline-container-orgeb19df0" class="outline-2">
250
-<h2 id="orgeb19df0">Introduction</h2>
251
-<div class="outline-text-2" id="text-orgeb19df0">
249
+<div id="outline-container-org6818d03" class="outline-2">
250
+<h2 id="org6818d03">Introduction</h2>
251
+<div class="outline-text-2" id="text-org6818d03">
252 252
 <p>
253
-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.
253
+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 <a href="./codeofconduct.html">Code of Conduct</a>.
254 254
 </p>
255 255
 </div>
256 256
 </div>
257
-<div id="outline-container-org70ef738" class="outline-2">
258
-<h2 id="org70ef738">Substitute for a Code of Conduct</h2>
259
-<div class="outline-text-2" id="text-org70ef738">
260
-<p>
261
-Instead of having some tedious <i>Code of Conduct</i> which tries to micro-manage how folks communicate privately with each other this project has a set of guiding principles, which are as follows:
262
-</p>
263
-
264
-<ul class="org-ul">
265
-<li>Enable users to help themselves to provide their own personal software infrastructure.</li>
266
-<li>Enable users to help each other to provide software infrastructure for a community.</li>
267
-<li>Principle of self-management: apps should require miniumum configuration and maintain themselves as far as possible.</li>
268
-<li>There should be no single point of failure. Assume that other servers can and will fail occasionally.</li>
269
-<li>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.</li>
270
-<li>Respect other users right to run their own stuff and have their own policies on their own hardware.</li>
271
-<li>Remove as many intermediating organisations as possible. For example, Google tracking embedded within some Free Software apps.</li>
272
-<li>No tollbooths, rent-seeking, gatekeepers or paywalls.</li>
273
-<li>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.</li>
274
-</ul>
275
-</div>
276
-</div>
277
-
278
-<div id="outline-container-orgce166ed" class="outline-2">
279
-<h2 id="orgce166ed">Adding extra apps</h2>
280
-<div class="outline-text-2" id="text-orgce166ed">
257
+<div id="outline-container-org080672c" class="outline-2">
258
+<h2 id="org080672c">Adding extra apps</h2>
259
+<div class="outline-text-2" id="text-org080672c">
281 260
 <p>
282 261
 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.
283 262
 </p>
@@ -287,8 +266,8 @@ On an installed system the app scripts go into the directory:
287 266
 </p>
288 267
 
289 268
 <div class="org-src-container">
290
-<pre><code class="src src-bash">/usr/share/freedombone/apps
291
-</code></pre>
269
+<pre class="src src-bash">/usr/share/freedombone/apps
270
+</pre>
292 271
 </div>
293 272
 
294 273
 <p>
@@ -296,8 +275,8 @@ and within the project repo they appear within the <i>src</i> directory. Your ne
296 275
 </p>
297 276
 
298 277
 <div class="org-src-container">
299
-<pre><code class="src src-bash">freedombone-app-[myappname]
300
-</code></pre>
278
+<pre class="src src-bash">freedombone-app-[myappname]
279
+</pre>
301 280
 </div>
302 281
 
303 282
 <p>
@@ -309,7 +288,7 @@ An example template for an app script is shown below. Copy this and add whatever
309 288
 </p>
310 289
 
311 290
 <div class="org-src-container">
312
-<pre><code class="src src-bash"><span class="org-comment-delimiter">#</span><span class="org-comment">!/bin/</span><span class="org-keyword">bash</span>
291
+<pre class="src src-bash"><span class="org-comment-delimiter">#</span><span class="org-comment">!/bin/</span><span class="org-keyword">bash</span>
313 292
 <span class="org-comment-delimiter"># </span><span class="org-comment">Copyright (C) Year YourName &lt;YourEmail&gt;</span>
314 293
 <span class="org-comment-delimiter">#</span>
315 294
 <span class="org-comment-delimiter"># </span><span class="org-comment">This program is free software: you can redistribute it</span>
@@ -520,7 +499,7 @@ An example template for an app script is shown below. Copy this and add whatever
520 499
 }
521 500
 
522 501
 <span class="org-comment-delimiter"># </span><span class="org-comment">NOTE: deliberately no exit 0</span>
523
-</code></pre>
502
+</pre>
524 503
 </div>
525 504
 
526 505
 <p>
@@ -528,8 +507,8 @@ To test your app log into your system, select <b>Exit to command line</b> then g
528 507
 </p>
529 508
 
530 509
 <div class="org-src-container">
531
-<pre><code class="src src-bash">sudo su
532
-</code></pre>
510
+<pre class="src src-bash">sudo su
511
+</pre>
533 512
 </div>
534 513
 
535 514
 <p>
@@ -541,8 +520,8 @@ And run the admin control panel:
541 520
 </p>
542 521
 
543 522
 <div class="org-src-container">
544
-<pre><code class="src src-bash">control
545
-</code></pre>
523
+<pre class="src src-bash">control
524
+</pre>
546 525
 </div>
547 526
 
548 527
 <p>
@@ -555,9 +534,9 @@ Submit your working app to <b><a href="https://github.com/bashrc/freedombone/iss
555 534
 </div>
556 535
 </div>
557 536
 
558
-<div id="outline-container-org2e7b384" class="outline-2">
559
-<h2 id="org2e7b384">Customising mesh images</h2>
560
-<div class="outline-text-2" id="text-org2e7b384">
537
+<div id="outline-container-orge29cd52" class="outline-2">
538
+<h2 id="orge29cd52">Customising mesh images</h2>
539
+<div class="outline-text-2" id="text-orge29cd52">
561 540
 <p>
562 541
 If you want to make your own specially branded version of the mesh images, such as for a particular event, then to change the default desktop backgrounds edit the images within <b>img/backgrounds</b> and to change the available avatars and desktop icons edit the images within <b>img/avatars</b>. Re-create disk images using the instructions shown previously.
563 542
 </p>

+ 2
- 2
website/EN/index.html View File

@@ -3,7 +3,7 @@
3 3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5 5
 <head>
6
-<!-- 2017-11-27 Mon 13:21 -->
6
+<!-- 2017-12-20 Wed 12:40 -->
7 7
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
8 8
 <meta name="viewport" content="width=device-width, initial-scale=1" />
9 9
 <title>&lrm;</title>
@@ -290,7 +290,7 @@ After installation it's possible that you might want some advice on how to run y
290 290
 </ul>
291 291
 
292 292
 <p>
293
-If you find bugs, or want to add a new app to this system see the <a href="./devguide.html">Developers Guide</a>.
293
+If you find bugs, or want to add a new app to this system see the <a href="./devguide.html">Developers Guide</a> and <a href="./codeofconduct.html">Code of Conduct</a>.
294 294
 </p>
295 295
 
296 296
 <p>