datatracker
datatracker copied to clipboard
ietf-tools
Markdown support for charters
keyword_sprint owner:[email protected] type_enhancement | by [email protected]
Could we allow charters to be edited in Markdown? That would greatly improve their web rendering, and ASCII representations can be easily obtained, too.
Issue migrated from trac:2695 at 2022-03-04 07:08:35 +0000
@[email protected] commented
See the thread at https://mailarchive.ietf.org/arch/msg/wgchairs/9UowL13aj-TBh1zg_Rd2Ie-tE5g.
While this wouldn't be particularly hard, it will require choosing what we mean when we say "markdown".
@[email protected] commented
When addressing this, an indication of upload processing (defaulting to none) should be added to the upload form. We already have support in other parts of the datatracker for one format in the 'Structured Text' class of formats, reStructuredText, and it would be trivially easy to add support for that at the same time. We should however not be making guesses about the processing needed, so an explicit processing choice is needed.
@[email protected] commented
I believe this should just work now that the markdown changes have been committed. If it doesn't, I can fix this. The charter needs to be submitted as a ".md" file for the mime type to be recognized as text/markdown.
@[email protected] commented
I think the markdown changes that have been made only apply to meeting materials.
I don't see where in the processing chain it's been made available for charters. Am I missing something? On what page would the upload you mention above happen? I would expect it to be at somewhere like /doc/charter-ietf-stir/submit/recharter/.
@[email protected] commented
Just looked into this more and the charter upload form in ietf/doc/views_charter.py is completely different than the other areas where files can be uploaded. It looks pretty messy to change this to accept markdown. Is there a reason we need to be able to paste in the text into a text field? I think only allowing upload would be better because we could then determine a MIME type.
@[email protected] commented
Hrmph - I typed this comment in once already, but it seems to have blackholed - trying again. Apologies if it appears twice:
Yes, the process ADs use to develop charters naturally led to a need to paste text into the form. Often they are pasting from email.
This is also true of for Reviews. The forms there allow pasting, uploading, or fetching from the email archives - we need to leave all of those in place.
I think this means that we need to add the ability on the form where we allow pasting to ask the user what the content is, and set the content type there appropriately.
@[email protected] commented
From d7841409ca44ae1762ec3ec648c3df94b6314a0c:
Provide a page that shows how current charter text renders through markdown. Related to #2695. Commit ready for merge.
@[email protected] commented
From 8cd1970e559e4404f487cf19496b36ca8531296e:
Merged in d7841409ca44ae1762ec3ec648c3df94b6314a0c from [email protected]: Provide a page that shows how current charter text renders through markdown. Related to #2695.
Time to wake this back up. The rendertest has been in place for almost a year, and the feedback of the results has stopped. The IESG has worked out the ability to make cosmetic changes - we need to finish deploying this.
