Date
1 - 4 of 4
[RFC] Documents under RedfishPkg
|
Hi edk2 Stewards,
Is that ok to put some EDK2 Redfish port guide or design block diagrams in a folder under RedfishPkg? e.g. RedfishPkg/Documents? Any practices we have on the current edk2 repo? Thanks Abner |
|
|
|
Laszlo Ersek
On 03/26/21 16:42, Abner Chang wrote:
Hi edk2 Stewards,If you can add the documents in some text-based representation (markup or plaintext), where "reviewing patches" will make sense in the future, then I welcome adding the documentation under RedfishPkg. (If you have diagrams, I think SVG might be good for those.) Other packages have introduced porting and other accompanying documentation in the wiki, but I find that inferior. I don't like it when documentation lives in a separate repository from the code that it documents. Thanks Laszlo |
|
|
|
Michael D Kinney
Hi Abner,
toggle quoted message
Show quoted text
PlantUML is a way to embed some graphics in GitHub markdown text. Avoids checking in SVG or BMP or PNG binaries. https://plantuml.com/ https://plantuml.com/en/guide Here is an example of using PlatUML from a Wiki page with the PlantUML source text file also checked in. https://github.com/tianocore-docs/edk2-TemplateSpecification/wiki/TianoCore-Documents-GitBook-Overview#introduction GitHub Markdown source line that uses PlantUML server to convert PlantUML source to a SVG when the page is viewed.  PlantUML source file https://raw.githubusercontent.com/wiki/tianocore-docs/edk2-TemplateSpecification/plantuml/GitBookOverview.puml Mike -----Original Message----- |
|
|
|
Thanks Mike and Laszlo for the comments.
toggle quoted message
Show quoted text
I would have the readme markdown under RedfishPkg with SVG for the complex diagrams. PlantUML is good to the porting guide markdown for easy review. Abner -----Original Message----- |
|
|