Roundup Tracker - Issues

Issue 2551102

Refactor doc/customizing.txt split using diataxis framework
Type: Severity: normal
Components: Documentation Versions: devel
Status: new
: : rouilj, schlatterbeck
Priority: : Effort-Medium, StarterTicket

Created on 2020-11-10 05:48 by rouilj, last changed 2022-09-13 19:51 by rouilj.

msg7025 Author: [hidden] (rouilj) Date: 2020-11-10 05:48
The customizing.txt file is getting large and difficult to find
information in it.

It is a mix of "how to do something": Change cache-control headers, add 
timelog class,  adding external authentication, spam prevention ...

and manual on schema methods and classes, tracker configuration, tal 
methods, detectors, access controls ....

I added indexing to it but there is still a long ways to go. I think
this document is trying to do too much. Maybe split it into a
reference manual (extended design doc...) and recipes for doing
things would be helpful?

A lot of 'doing things' examples exists on the wiki as well and
it would be good to reference interesting items from there in the
msg7082 Author: [hidden] (rouilj) Date: 2021-02-15 17:41
Consider applying for

On IRC irc://irc.oftcnet/roundup I asked taggnostr if the python
org would be able to accept a grant since roundup isn't a charitable 
entity in the US. Using python org would be the same as for the GSOC
that resulted in the rest code for roundup.
msg7647 Author: [hidden] (rouilj) Date: 2022-09-13 19:51
for reference:

Even small changes to split the doc would be helpful.
Date User Action Args
2022-09-13 19:51:53rouiljsetkeywords: + Effort-Medium, StarterTicket
messages: + msg7647
title: Refactor doc/customizing.txt -> Refactor doc/customizing.txt split using diataxis framework
2021-02-15 17:41:15rouiljsetnosy: + schlatterbeck
messages: + msg7082
2020-11-10 05:48:31rouiljcreate