Roundup Tracker - Issues

Message7916

Author rouilj
Recipients asavchuk, rouilj
Date 2023-12-25.16:08:39
Message-id <20231225160835.C4BE76A01F3@pe15.cs.umb.edu>
In-reply-to <trinity-f763f1fc-314f-4c60-9a7b-0509a231dc9f-1703413880072@3c-app-mailcom-bs06>
Hi Anton:

In message
<trinity-f763f1fc-314f-4c60-9a7b-0509a231dc9f-1703413880072@3c-app-m
ailcom-bs06>, Anton Savchuk writes:

Nice job on the improvements.

>> Thanks for opening the issue. Let's see if people agree it can
>> replace the existing jinja2
>> template (which I think is using the developer schema??). Then we
>> can either add it to the
>> distributed trackers or replace the existing bootstrap based template.
>> Also we can work out how to handle maintenance and migrations/upgrades
>> across releases.
>
> The current jinja2 template is based on the classic scheme, so updating
> it was much easier =)

We will need to figure out a way to sync your github repo into the
Roundup mercurial repo. This way the Roundup code base will reflect
your changes.

It may be the case that changes in Roundup require changes to your
tracker template to work with the newest unreleased Roundup. We would
need to document these in upgrading.txt and figure out when they can
get published in your repo if they are not compatible with earlier
roundup releases.

>I wrote to the Roundup-users list and asked for feedback.

I saw that. They arrived the day before Christmas. Very nice
touch 8-).

> I'm thinking that if the templates get positive feedback and maybe
> some fixes, I might try to help port the template based on developer
> schema from TAL to Jinja using current work. Then we could have
> modern jinja2-devel and jinja2-classic templates in addition to
> TAL-based devel and classic templates.

That's a great idea. Having a jinja2-classic to compare with a
jinja2-devel is also great documentation.

>Additionally, while this work is ongoing, it will be easier to
>include information about Jinja2 in the documentation.

Very true since most of the customizing doc is based on the classic
template.

Ideally we could provide the same examples in both TAL and
jinja2. Unlike mapping the same structure in yaml and json, there may
not be an exact 1:1 mapping between TAL and Jinja2. We might need to
rewrite some of the customizing doc examples. However revising the doc
to follow diataxis has been on my plate for a few years.

However the current TAL example provide a framework on what to
document.  Ideally we could present the code examples in a widget that
allows the user to view the TAL or Jinja2 implementation.

I'm not sure if sphinx can handle that, but it seems like embedding an
HTML web component in a sphinx `.. raw:: html` directive might
work. One child of the component is TAL code and the other is jinja2
code. Worst case both examples are shown one after the other rather
than in a viewable tab.

I don't want to end up with separate customizing_with_tal and
customizing_with_jinja docs. That pretty much guarantees that one or
the other will be unmaintained.

>> Also which markdown
>> renderer (markdown, markdown2, mistune) are you using with your tracker?
>
>Sorry, I missed this in my previous reply. I use markdown
>library. Markdown2 works for me too. Mistune doesn't work for me, but

Thanks for the data point. It could be because mistune==0.8.4 is what
we support. Support for 2.x mistune has an open ticket
https://issues.roundup-tracker.org/issue2551198.
History
Date User Action Args
2023-12-25 16:08:40rouiljsetrecipients: + rouilj, asavchuk
2023-12-25 16:08:40rouiljlinkissue2551308 messages
2023-12-25 16:08:39rouiljcreate