2018-11-21 04:26 CET

View Issue Details Jump to Notes ]
IDProjectCategoryView StatusLast Update
0005121GNUnetwebpagepublic2018-10-30 19:15
Reporterng0 
Assigned To 
PrioritynormalSeverityminorReproducibilityhave not tried
StatusconfirmedResolutionopen 
Product VersionSVN HEAD 
Target Version0.11.0Fixed in Version 
Summary0005121: gnunet.org: create docs.gnunet.org where the documentation is available, and further actions
Description> A git hook or a cron job could then move the result of this to
> for example docs.gnunet.org, which could be set up even before we
> have the new website.

1. We need a "make doc" so that we don't rely on build gnunet for just building the documentation.
2. It should be available at docs.gnunet.org/gnunet/ to ensure that we could potentially have other documentation or text documents at docs.gnunet.org/$name/.
3. A git hook or a cron job could automate this, but the documentation has to build, so we need a check before it is deployed.
TagsNo tags attached.
Attached Files

-Relationships Relation Graph ] Dependency Graph ]
child of 0005140assignedng0 creation of next gnunet.org (meta-issue) 
+Relationships

-Notes

~0012389

ng0 (developer)

After an initial plain texinfo output, we should consider using sphinx for this job in the future if we get translated documentation.
But this is out of the scope of this bug and should be in a new one.

~0012390

ng0 (developer)

Last edited: 2017-08-24 12:55

View 2 revisions

> 1. We need a "make doc" so that we don't rely on build gnunet for just building the documentation.

This is resolved and a gnunet-doc package added in the last commits shows how this could be run. However, it still depends on the full dependency checks, so we should introduce something to bypass them.

~0012391

ng0 (developer)

How much of the basic dependencies are available on the web server? If it just runs like this we could continue to step 2 and 3.

~0012459

Christian Grothoff (manager)

Are all the dependencies we need in Guix? I would really prefer to have a clean, fully automated and fully cloneable system definition based on Guix for gnunet.org in the future. If that's unrealistic, I can trivially install whatever Debian packages are missing on gnunet.org.

~0012524

ng0 (developer)

As a note on documentation, not the OS-specific task I work on:
- Change on the recent branch I work on:

I now make use of the same utilities GNU uses to create the Manual/Documentation Pages for hosted projects.
So the documentation builds with the tools present in Guix (and should be portable to other systems even without Guix).
This way to build the Documentation still needs some styling, etc.

~0012549

ng0 (developer)

I presented two options to the Tor developer community with regards to work on this.
As you can read in this thread, they are open to improving anonbib and sharing efforts to maintain it.
As I believe in fixing problems in cross-community, cross-projects efforts holds more value and reduces the duplicity, this is the way to go. It's still an early idea, but we would basically improve anonbib (many dead links in there), add our own content (GNUnet related papers) and host it in addition to the anonbib site, so that we have two locations. (a rough and short idea)
What do you think?
https://lists.torproject.org/pipermail/tor-dev/2017-November/012545.html

~0012550

ng0 (developer)

Last edited: 2017-11-04 16:39

View 2 revisions

Additional note:

-> docs.gnunet.org/manual/$NAME

where $NAME is the software, holds the documentation.

-> docs.gnunet.org/anonbib/

would hold the anonbib.

Generation of anonbib is easy, with some pre-recorded hashes it could be done with Guix. I've build it in Guix and updated the cache with the build software outside of the build system. It's possible to do this from within the build system.

~0012551

Christian Grothoff (manager)

Working together on the anonbib code: great. Just to clarify: we would host _our_ bibligraphy and they'd continue to host theirs, right? Because the focus (secure P2P vs. anonymity) is somewhat different, so it does make sense to have two different sites with different papers.

~0012552

ng0 (developer)

> we would host _our_ bibligraphy and they'd continue to host theirs, right?

Yes, although my initial idea was that ours would just be anonbib.cfg extended by our material.
We already have a large mixture in our bibliography mess right now as far as I can tell.

With the system as it is in anonbib.git, anything is possible. But as grarpamp wrote, the code is old the layout needs improvements and patches are welcome.

~0012562

ng0 (developer)

Some pastes of interest from the ongoing thread.

Roger Dingledine writes:

See also the censorbib, for another example.

Moritz Bartl writes:

There's also a mixnet bibliography at https://bib.mixnetworks.org/ /
https://github.com/applied-mixnetworks/mixbib . If you come across
papers related to mixnets, please submit a patch! Also, we should add
highlights like the anonbib has.

~0012563

ng0 (developer)

Censorbib: https://censorbib.nymity.ch/

~0012737

ng0 (developer)

To get back on topic, as I wrote in an email earlier this week:

We'll need https://docs.gnunet.org:
* certificates (easy, LE certs expanding to this subdomain, cronjob daily to check for renewal)
* a location to deploy the gnunetbib (I've started fixing it up), I propose /bib/
* a location to deploy the documentation, I suggest /manual/

Both of these locations should be updated via automated procedures, git hooks or cronjobs.

~0013100

Christian Grothoff (manager)

docs.gnunet.org is online. bib.gnunet.org can be quickly put online once we have the generator ready somewhere.

~0013103

ng0 (developer)

looking good so far.
I expect that there will be a landing page on docs.gnunet.org eventually and subfolder style for documents (TYPE/PROJECT/*).
This way we don't need bib.gnunet.org and can make the bibliography available in docs.gnunet.org/bibliography/
+Notes

-Issue History
Date Modified Username Field Change
2017-08-18 14:36 ng0 New Issue
2017-08-18 14:37 ng0 Summary gnunet.org: create docs.gnunet.org where the documentation is available => gnunet.org: create docs.gnunet.org where the documentation is available, and further actions
2017-08-18 14:38 ng0 Description Updated View Revisions
2017-08-24 10:51 ng0 Note Added: 0012389
2017-08-24 12:54 ng0 Note Added: 0012390
2017-08-24 12:55 ng0 Note Edited: 0012390 View Revisions
2017-08-24 13:17 ng0 Note Added: 0012391
2017-08-24 13:18 ng0 Assigned To => Christian Grothoff
2017-08-24 13:18 ng0 Status new => feedback
2017-09-27 20:13 ng0 Relationship added child of 0005140
2017-09-27 20:19 ng0 Relationship added child of 0005141
2017-10-04 15:21 Christian Grothoff Note Added: 0012459
2017-10-04 15:22 Christian Grothoff Assigned To Christian Grothoff => ng0
2017-10-28 23:47 ng0 Note Added: 0012524
2017-11-04 16:35 ng0 Note Added: 0012549
2017-11-04 16:36 ng0 Assigned To ng0 => Christian Grothoff
2017-11-04 16:37 ng0 Note Added: 0012550
2017-11-04 16:37 ng0 Status feedback => assigned
2017-11-04 16:39 ng0 Note Edited: 0012550 View Revisions
2017-11-04 17:09 Christian Grothoff Note Added: 0012551
2017-11-04 17:21 ng0 Note Added: 0012552
2017-11-04 20:59 ng0 Note Added: 0012562
2017-11-04 21:21 ng0 Note Added: 0012563
2017-11-05 00:06 ng0 Note Added: 0012565
2017-11-06 17:27 ng0 Note Deleted: 0012565
2018-01-07 20:22 ng0 Note Added: 0012737
2018-06-07 00:54 Christian Grothoff Assigned To Christian Grothoff =>
2018-06-07 00:54 Christian Grothoff Status assigned => confirmed
2018-06-07 00:54 Christian Grothoff Product Version => SVN HEAD
2018-06-07 00:54 Christian Grothoff Target Version => 0.11.0
2018-06-28 10:36 Christian Grothoff Note Added: 0013100
2018-06-28 11:55 ng0 Note Added: 0013103
2018-10-30 19:15 ng0 Relationship deleted child of 0005141
+Issue History