Release notes and other documentation files in the release package render poorly in HTML

[rjyounes]

In particular, there is no indentation of bullet points, which is highly problematic.

This could be entirely an onto_tool issue, but I've added the issue here because it is creating a problem in gist.

If this could be fixed before the next release I propose that we serve up the corrected version on the website and possibly slip the file into the download (or does the latter require a patch release?)

[rjyounes]

Fix with #924.

[bpelakh]

There have been some issues with the Python package used to convert Markdown to HTML during the build, especially around nested lists. It also appears, as seen in the most recent release notes, that tables don't render correctly. We can look into upgrading the rendering package.

In the past, I've had to mess around with the Markdown to make sure the HTML rendered properly. It should be the responsibility of the release manager to run the build and double-check that documents look OK after the export.

[rjyounes]

I've had to mess around with the Markdown to make sure the HTML rendered properly

Can you provide some guidance on how to patch the Markdown so that we don't have to edit the HTML directly? You could add instructions under item 11 here: https://semarts.atlassian.net/wiki/spaces/OF/pages/1126760539/gist+Release+Management+Ontologists.

[Jamie-SA]

Maybe there are better converters out there.

[rjyounes]

Strange that the bulleted list works in the MajorVersionMigration file.

[Jamie-SA]

I think this should have been closed when #928 & #923 where merged & closed, except that the "fixes" and "resolves" hints only work on the default branch, not on our release branches. I'm going to close this issue.