[Privoxy-devel] Adding a HTTPS inspection HowTo (was: Changing the Privoxy version number scheme)

[Ian Silvester]

On Mon, 20 Feb 2023, at 02:36, Fabian Keil wrote:
> Roland Rosenfeld <roland at spinnaker.de> wrote on 2023-02-19 at 21:53:49:
>
>> On Fri, 17 Feb 2023, Fabian Keil wrote:
>> 
>> > Roland Rosenfeld <roland at spinnaker.de> wrote on 2023-01-05 at 16:36:26:
>> 
>> > > Maybe it would be an option to release 4.0 with two great "new"
>> > > features: HTTPS inspection and Client-Tags.
>> > > Both of them are really great, but it's quite hard to understand how
>> > > they need to be configured.
>> > > So we could launch 4.0 with two new HOWTOs, that explain step by step
>> > > with examples how to configure them.
>> > > Okay, someone has to write these HOWTOs first, but Fabian suggested to
>> > > change the version scheme _after_ the next release, so this should be
>> > > possible.
>> 
>> > I think you're English is good enough to write documentation.
>> 
>> Okay I wrote a first draft of such an HOWTO (plain text, no
>> formatting nor hyperlinks, and no DeepL Write fine tuning, and only
>> from my Debian point of view, no MacOS, Windows or BSD...).
>
> Great.

Thanks Roland! If you commit your first draft then I'll give it a once over to add anything Mac-specific. I have a hunch this might be cross-platform though.

>
>> What do you think, where should I place this HOWTO?  Currently I tend
>> to add it to the user-manual, since it's not a question (this would
>> fit in the FAQ), but an explanation with some chapters:
>> 
>> Currently I have (draft!):
>> 
>> HTTPS-Inspection
>>  How TLS-Certificates for websites work
>>  How HTTPS inspection works
>>  What happens, if the original certificate is invalid?
>>  Configuration of HTTPS inspection in privoxy
>>  Browser configuration
>>  Activation of HTTPS inspection
>> Client-Tags
>> 
>> 
>> Maybe I could insert this between
>> 10. Privoxy's Template Files
>> and
>> 11. Contacting the Developers, Bug Reporting and Feature Requests
>> maybe as two new <sect2> below a new <sect1> "HOWTOs"?
>
> Your suggestion makes sense to me.

I concur.

> We can always change the position later if we feel like it.
> For example we could add HowTos as another category of documentation
> and even experiment with WML instead of SGML like the TODO item #41
> suggests:
>
> | 41) Change documentation framework to one that works cross-platform.
> |     Evaluate WML and txt2tags.
>
> I think using SGML will do for now, though.

Agree - if it ain't broke don't fix it. Our documentation workflow has its, ah, uniquenesses, but it's not actually broken ;)

Ian

>
> Fabian
>
> _______________________________________________
> Privoxy-devel mailing list
> Privoxy-devel at lists.privoxy.org
> https://lists.privoxy.org/mailman/listinfo/privoxy-devel