From 80ee82d9f984ffe30fa77f30d153e60a383709a6 Mon Sep 17 00:00:00 2001 From: Martin Schanzenbach Date: Mon, 6 Jul 2020 10:27:02 +0200 Subject: -fix: handbook updates --- doc/handbook/chapters/developer.texi | 37 +++++++++++++++++------------------- doc/handbook/chapters/preface.texi | 11 ++++++++++- 2 files changed, 27 insertions(+), 21 deletions(-) (limited to 'doc') diff --git a/doc/handbook/chapters/developer.texi b/doc/handbook/chapters/developer.texi index ca76a5f2b..fd48fb9ab 100644 --- a/doc/handbook/chapters/developer.texi +++ b/doc/handbook/chapters/developer.texi @@ -92,33 +92,25 @@ introduction, each of the GNUnet subsystems (directories in the addition to this documentation, GNUnet developers should be aware of the services available on the GNUnet server to them. -New developers can have a look a the GNUnet tutorials for C and java -available in the @file{src/} directory of the repository or under the -following links: +New developers can have a look a the @uref{https://docs.gnunet.org/tutorial/gnunet-tutorial.html, GNUnet C tutorial}. @c ** FIXME: Link to files in source, not online. @c ** FIXME: Where is the Java tutorial? -@itemize @bullet -@item @xref{Top, Introduction,, gnunet-c-tutorial, The GNUnet C Tutorial}. -@item @uref{https://docs.gnunet.org/tutorial/gnunet-tutorial.html, GNUnet C tutorial} -@item GNUnet Java tutorial -@end itemize In addition to the GNUnet Reference Documentation you are reading, the GNUnet server at @uref{https://gnunet.org} contains various resources for GNUnet developers and those who aspire to become regular contributors. They are all conveniently reachable via the "Developer" -entry in the navigation menu. Some additional tools (such as static -analysis reports) require a special developer access to perform certain +entry in the navigation menu. Some additional tools (such as continuous +integration) require a special developer access to perform certain operations. If you want (or require) access, you should contact -@uref{http://grothoff.org/christian/, Christian Grothoff}, -GNUnet's maintainer. +GNUnet's maintainers. @c FIXME: A good part of this belongs on the website or should be @c extended in subsections explaining usage of this. A simple list @c is just taking space people have to read. -The public subsystems on the GNUnet server that help developers are: +The developer services on the GNUnet project infrastructure are: @itemize @bullet @@ -136,19 +128,21 @@ It can be accessed at @uref{https://bugs.gnunet.org/, https://bugs.gnunet.org/}. Anyone can report bugs. -@item The current quality of our automated test suite is assessed using -code coverage analysis. Testcases that -improve our code coverage are always welcome. +@item Continuous integration (Buildbot). +Used to build gnunet and its websites upon new commits. +It can be accessed at +@uref{https://buildbot.gnunet.org/, https://buildbot.gnunet.org/}. +Anyone can see the builds. -@item We try to automatically find bugs using a static analysis using -various tools. Note that not everything that is flagged by the +@item Regularly we make use of static analysis tools. +Note that not everything that is flagged by the analysis is a bug, sometimes even good code can be marked as possibly problematic. Nevertheless, developers are encouraged to at least be aware of all issues in their code that are listed. -@item We use Gauger for automatic performance regression visualization. +@c @item We use Gauger for automatic performance regression visualization. @c FIXME: LINK! -Details on how to use Gauger are here. +@c Details on how to use Gauger are here. @end itemize @@ -515,6 +509,9 @@ without exposing the private input vectors of the peers to each other. @item @file{consensus/} The consensus service will allow a set of peers to agree on a set of values via a distributed set union computation. +@item @file{reclaim/} +A decentralized personal data sharing service used to realize a decentralized +identity provider. Supports OpenID Connect. See also @uref{https://reclaim.gnunet.org}. @item @file{rest/} The rest API allows access to GNUnet services using RESTful interaction. The services provide plugins that can exposed by the rest server. diff --git a/doc/handbook/chapters/preface.texi b/doc/handbook/chapters/preface.texi index 443fb2600..e64d6ee55 100644 --- a/doc/handbook/chapters/preface.texi +++ b/doc/handbook/chapters/preface.texi @@ -1,4 +1,4 @@ -@node Preface +doc/handbook/chapters/preface.texi@node Preface @chapter Preface @c FIXME: Do we have to mention that this is Free Software? @@ -181,6 +181,15 @@ GNUnet maintainer can overrule any decisions made by individual developers. Still, in practice neither has happened in the last 20 years for GNUnet, and we hope to keep it that way. +The current maintainers of GNUnet are: + +@itemize @bullet + +@item @uref{Christian Grothoff, https://grothoff.org/christian/} +@item @uref{Martin Schanzenbach, https://schanzen.eu} + +@end itemize + The GNUnet project is supported by GNUnet e.V., a German association where any developer can become a member. GNUnet e.V. serves as a legal entity to hold the copyrights to GNUnet. GNUnet e.V. may also -- cgit v1.2.3