[squid-dev] squid.conf future

[Alex Rousskov]

On 2/29/20 6:07 AM, Francesco Chemolli wrote:
> I like the idea of markdown, if possible.
> It is simple and gets the job done.
> Would processing it be more cumbersome than the alternatives?

If we look at the big picture rather then the next step, then the
answer, IMO, is "no". Many modern projects use markdown. I suspect there
are more modern/supported/quality tools processing markdown than
modern/supported/quality tools processing linuxdoc or similar XML-like
markup.

Moreover, _if_ we want that, we can avoid doing any mardown-to-HTML
conversion ourselves! Services like Github Pages do it for you
automatically. I am not (yet) saying that we should use such a service,
but I think we should at least _consider_ it because such services have
some serious advantages over the current web site integration approach.


Cheers,

Alex.


> On Wed, Feb 26, 2020 at 8:43 PM Alex Rousskov wrote:
> 
>     On 2/25/20 1:31 AM, Amos Jeffries wrote:
> 
>     > Any suggestions of formats I should look at then?
> 
>     I believe cf.data.pre should use two primary formats, each optimized
>     specifically for the content it is applied to. The secondary details of
>     each format will evolve, but here is where I would start today:
> 
>     1. YAML-like metadata to supply formal details about each directive. We
>     already use this today, and I expect no significant changes in the
>     immediate future (even though many improvements are possible in this
>     area!).
> 
>     2. Markdown for informal documentation inside DOC_START...DOC_END,
>     DEFAULT_DOC, and similar text blocks. Preprocessing includes validation
>     of internal references (for sure), generation of internal anchors
>     (probably), and removal of minimal common indentation (not sure; need to
>     experiment/discuss). Other preprocessing actions may be desirable as
>     well, of course. An agreement on the lower-level details and a
>     non-trivial conversion effort would be required. We can discuss whether
>     to do it incrementally or once-and-for-all.
> 
> 
>     HTH,
> 
>     Alex.
>     _______________________________________________
>     squid-dev mailing list
>     squid-dev at lists.squid-cache.org <mailto:squid-dev at lists.squid-cache.org>
>     http://lists.squid-cache.org/listinfo/squid-dev
> 
> 
> 
> -- 
>     Francesco