diff options
author | ng0 <ng0@n0.is> | 2019-03-18 17:12:40 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2019-03-18 17:12:40 +0000 |
commit | c6fdc95b014a274406499ac73de8d23112ed7784 (patch) | |
tree | 12ceef92b42f52e9450457599e3b4dc809ca7e63 | |
parent | f741c0969e3ffbf0083f565fb5e3b2426d3e1d0a (diff) | |
download | gnunet-c6fdc95b014a274406499ac73de8d23112ed7784.tar.gz gnunet-c6fdc95b014a274406499ac73de8d23112ed7784.zip |
preface: removed fixed TODO notes, add XXX notes, adjust content, fix grammar.
-rw-r--r-- | doc/handbook/chapters/preface.texi | 71 |
1 files changed, 40 insertions, 31 deletions
diff --git a/doc/handbook/chapters/preface.texi b/doc/handbook/chapters/preface.texi index 4b6610d2c..98ae6d4e5 100644 --- a/doc/handbook/chapters/preface.texi +++ b/doc/handbook/chapters/preface.texi | |||
@@ -1,13 +1,15 @@ | |||
1 | @node Preface | 1 | @node Preface |
2 | @chapter Preface | 2 | @chapter Preface |
3 | 3 | ||
4 | @c FIXME: Long sentence is long. | ||
4 | This collection of manuals describes how to use GNUnet, a framework | 5 | This collection of manuals describes how to use GNUnet, a framework |
5 | for secure peer-to-peer networking with the high-level goal to provide | 6 | for secure peer-to-peer networking with the high-level goal to provide |
6 | a strong foundation Free Software for a global, distributed network | 7 | a strong foundation Free Software for a global, distributed network |
7 | that provides security and privacy. GNUnet in that sense aims to | 8 | that provides security and privacy. |
8 | replace the current Internet protocol stack. Along with an | 9 | GNUnet in that sense aims to replace the current Internet protocol stack. |
9 | application for secure publication of files, it has grown to include | 10 | Along with an application for secure publication of files, it has grown to |
10 | all kinds of basic applications for the foundation of a new Internet. | 11 | include all kinds of basic applications for the foundation of a new |
12 | Internet. | ||
11 | 13 | ||
12 | @menu | 14 | @menu |
13 | * About this book:: | 15 | * About this book:: |
@@ -57,29 +59,34 @@ They are followed by chapters which need more work: | |||
57 | @section Contributing to this book | 59 | @section Contributing to this book |
58 | 60 | ||
59 | The GNUnet Reference Manual is a collective work produced by various | 61 | The GNUnet Reference Manual is a collective work produced by various |
60 | people throughout the years. The version you are reading is derived | 62 | people throughout the years. |
61 | from many individual efforts hosted on our website. This was a failed | 63 | |
62 | experiment, and with the conversion to Texinfo we hope to address this | 64 | The version you are reading is derived |
63 | in the longterm. Texinfo is the documentation language of the GNU project. | 65 | from many individual efforts hosted on one of our old websites. |
66 | In the end it was considered to be impractical to read by | ||
67 | those who required the information. | ||
68 | With the conversion to Texinfo --- the version you are reading | ||
69 | right now --- we hope to address this in the longterm. | ||
70 | Texinfo is the documentation language of the GNU project. | ||
71 | |||
64 | While it can be intimidating at first and look scary or complicated, | 72 | While it can be intimidating at first and look scary or complicated, |
65 | it is just another way to express text format instructions. We encourage | 73 | it is just another way to express text format instructions. |
66 | you to take this opportunity and learn about Texinfo, learn about GNUnet, | 74 | |
67 | and one word at a time we will arrive at a book which explains GNUnet in | 75 | We encourage you to take this opportunity and learn about Texinfo, |
68 | the least complicated way to you. Even when you don't want or can't learn | 76 | learn about GNUnet, and one word at a time we will arrive at a |
69 | Texinfo, you can contribute. Send us an Email or join our IRC chat room | 77 | book which explains GNUnet in the least complicated way to you. |
70 | on freenode and talk with us about the documentation (the prefered way | 78 | |
71 | to reach out is the mailinglist, since you can communicate with us | 79 | Even when you don't want to or can't learn Texinfo, you can contribute. |
72 | without waiting on someone in the chatroom). One way or another you | 80 | Send us an Email or join our IRC chat room on freenode and talk with |
73 | can help shape the understanding of GNUnet without the ability to read | 81 | us about the documentation (the prefered way to reach out is the |
74 | and understand its sourcecode. | 82 | mailinglist, since you can communicate with us without waiting on |
83 | someone in the chatroom). | ||
84 | One way or another you can help shape the understanding of GNUnet | ||
85 | without the ability to read and understand its sourcecode. | ||
75 | 86 | ||
76 | @node Introduction | 87 | @node Introduction |
77 | @section Introduction | 88 | @section Introduction |
78 | 89 | ||
79 | @c In less than 2 printed pages describe the history of GNUnet here, | ||
80 | @c what we have now and what's still missing (could be split into | ||
81 | @c subchapters). | ||
82 | |||
83 | GNUnet in its current version is the result of almost 20 years of work | 90 | GNUnet in its current version is the result of almost 20 years of work |
84 | from many contributors. So far, most contributions were made by | 91 | from many contributors. So far, most contributions were made by |
85 | volunteers or people paid to do fundamental research. At this stage, | 92 | volunteers or people paid to do fundamental research. At this stage, |
@@ -126,12 +133,17 @@ social network, resulting in a significant growth of the core team. | |||
126 | In 2013, we launched @uref{https://taler.net, GNU Taler} to address | 133 | In 2013, we launched @uref{https://taler.net, GNU Taler} to address |
127 | the challenge of convenient | 134 | the challenge of convenient |
128 | and privacy-preserving online payments. In 2015, the | 135 | and privacy-preserving online payments. In 2015, the |
129 | @c TODO: Maybe even markup for the E if it renders in most outputs. | 136 | @c XXX: It is not correct to refer to pEp as pEp stylistic, |
130 | @uref{https://pep.foundation/, pEp} (pretty Easy privacy) project | 137 | @c XXX: but the correct version would lead to problems with |
138 | @c XXX: some of our outputs and/or older versions of texinfo | ||
139 | @c XXX: and devices that display versions on consoles etc. | ||
140 | @c XXX: This is why we keep the pEp until proven that p(tripple bar)p | ||
141 | @c XXX: does not create broken outputs. | ||
142 | @uref{https://pep.foundation/, pretty Easy privacy} (pEp) project | ||
131 | announced that they will use GNUnet as the technology for their | 143 | announced that they will use GNUnet as the technology for their |
132 | meta-data protection layer, ultimately resulting in GNUnet e.V. | 144 | meta-data protection layer, ultimately resulting in GNUnet e.V. |
133 | entering into a formal long-term collaboration with the pEp | 145 | entering into a formal long-term collaboration with the pEp |
134 | foundation. In 2016, Taler Systems SA, a first startup using GNUnet | 146 | Foundation. In 2016, Taler Systems SA, a first startup using GNUnet |
135 | technology, was founded with support from the community. | 147 | technology, was founded with support from the community. |
136 | 148 | ||
137 | GNUnet is not merely a technical project, but also a political | 149 | GNUnet is not merely a technical project, but also a political |
@@ -148,7 +160,7 @@ Similarly its flaws are not limited to the protocol design. Thus, | |||
148 | technical excellence by itself will not suffice to create a better | 160 | technical excellence by itself will not suffice to create a better |
149 | network. We also need to build a community that is wise, humble and | 161 | network. We also need to build a community that is wise, humble and |
150 | has a sense of humor to achieve our goal to create a technical | 162 | has a sense of humor to achieve our goal to create a technical |
151 | foundation for a society we would like to live in. | 163 | foundation for a society we would like to live in. |
152 | 164 | ||
153 | 165 | ||
154 | @node Project governance | 166 | @node Project governance |
@@ -159,15 +171,12 @@ follows the governance model of a benevolent dictator. This means | |||
159 | that ultimately, the GNU project appoints the GNU maintainer and can | 171 | that ultimately, the GNU project appoints the GNU maintainer and can |
160 | overrule decisions made by the GNUnet maintainer. Similarly, the | 172 | overrule decisions made by the GNUnet maintainer. Similarly, the |
161 | GNUnet maintainer can overrule any decisions made by individual | 173 | GNUnet maintainer can overrule any decisions made by individual |
162 | @c TODO: Should we mention if this is just about GNUnet? Other projects | ||
163 | @c TODO: in GNU seem to have rare issues (GCC, the 2018 documentation | ||
164 | @c TODO: discussion. | ||
165 | developers. Still, in practice neither has happened in the last 20 | 174 | developers. Still, in practice neither has happened in the last 20 |
166 | years, and we hope to keep it that way. | 175 | years for GNUnet, and we hope to keep it that way. |
167 | 176 | ||
168 | @c TODO: Actually we are a Swiss association, or just a German association | 177 | @c TODO: Actually we are a Swiss association, or just a German association |
169 | @c TODO: with Swiss bylaws/Satzung? | 178 | @c TODO: with Swiss bylaws/Satzung? |
170 | @c TODO: Rewrite one of the 'GNUnet eV may also' sentences. | 179 | @c TODO: Rewrite one of the 'GNUnet eV may also' sentences? |
171 | The GNUnet project is supported by GNUnet e.V., a German association | 180 | The GNUnet project is supported by GNUnet e.V., a German association |
172 | where any developer can become a member. GNUnet e.V. serves as a | 181 | where any developer can become a member. GNUnet e.V. serves as a |
173 | legal entity to hold the copyrights to GNUnet. GNUnet e.V. may also | 182 | legal entity to hold the copyrights to GNUnet. GNUnet e.V. may also |