On 4/19/20 10:29 AM, Sean via groups.io wrote:
Laszlo,
Regarding your comments about disliking the verbosity of the markdown
table/html table for build status both in Core Ci and now these Platform CI
readme files.
As a learning experience I updated the OvmfPkg readme to use reStructuredText
instead of markdown. Not sure if I like RST but it does allow the links to not
be in html and supports directives so you can push all that text to end of the
file.
Do you like this enough that I should rework all three readmes and we should
discuss if RST should be used instead of MD for the edk2 project?
RST version:
https://github.com/spbrogan/edk2/blob/PlatformAndCoreCIForOvmfArmVirtEmulatorPackages_v8/OvmfPkg/README.rst
MD version:
https://github.com/spbrogan/edk2/blob/PlatformAndCoreCIForOvmfArmVirtEmulatorPackages_v7/OvmfPkg/README-pytools.md
I think the rendered RST looks really good, and is perfectly usable as
plaintext too. AFAICT, we are not losing out on anything the v7 version
provided, right? If not, I am in favor of going with RST in this case,
which I suppose implies that I am in favor of permitting it in EDK2 for
purposes such as this one.
That does not necessarily imply that all markdown should be replaced
with RST. I'm perfectly happy letting them co-exist, and I don't have an
opinion on whether one should be recommended over the other, or which
that should have to be.
This is really the last remaining issue for the PlatformCI patchset.
Agreed. This is converging really nicely.
--
Ard.
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#57563): https://edk2.groups.io/g/devel/message/57563
Mute This Topic: https://groups.io/mt/72880537/21656
Group Owner: devel+ow...@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-
