<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Thu, Jun 7, 2018 at 1:45 PM, Gedare Bloom <span dir="ltr"><<a href="mailto:gedare@rtems.org" target="_blank">gedare@rtems.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Hello Chris, Dannie,<br>
<br>
I am leaning toward a lighter method such as markdown for the release<br>
notes. They are not necessary to be a beautifully formatted document.<br>
Some basic document sectioning, lists, and url support seems<br>
sufficient to me. This would also be easily parseable by other tools<br>
in case someone wants to write some further scripts to process the<br>
release notes, for example, to generate traceability documentation.<br></blockquote><div><br></div><div><br></div><div>
<div style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:12.8px;font-style:normal;font-variant-ligatures:normal;font-variant-caps:normal;font-weight:400;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;background-color:rgb(255,255,255);text-decoration-style:initial;text-decoration-color:initial">I am OK with using something simple like markdown. The output needs</div><div style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:12.8px;font-style:normal;font-variant-ligatures:normal;font-variant-caps:normal;font-weight:400;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;background-color:rgb(255,255,255);text-decoration-style:initial;text-decoration-color:initial">to be "acceptable", not "beautiful". Plus I expect that there will be things</div><div style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:12.8px;font-style:normal;font-variant-ligatures:normal;font-variant-caps:normal;font-weight:400;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;background-color:rgb(255,255,255);text-decoration-style:initial;text-decoration-color:initial">in some tickets which are nearly impossible to pass through any processing</div><div style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:12.8px;font-style:normal;font-variant-ligatures:normal;font-variant-caps:normal;font-weight:400;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;background-color:rgb(255,255,255);text-decoration-style:initial;text-decoration-color:initial">and formatter without getting mangled. Might as well keep it simple.</div><div style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:12.8px;font-style:normal;font-variant-ligatures:normal;font-variant-caps:normal;font-weight:400;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;background-color:rgb(255,255,255);text-decoration-style:initial;text-decoration-color:initial"><br></div><div style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:12.8px;font-style:normal;font-variant-ligatures:normal;font-variant-caps:normal;font-weight:400;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;background-color:rgb(255,255,255);text-decoration-style:initial;text-decoration-color:initial">Is there documentation on the markdown format supported by the RSB?</div><div style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:12.8px;font-style:normal;font-variant-ligatures:normal;font-variant-caps:normal;font-weight:400;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;background-color:rgb(255,255,255);text-decoration-style:initial;text-decoration-color:initial"><br></div><div style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:12.8px;font-style:normal;font-variant-ligatures:normal;font-variant-caps:normal;font-weight:400;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;background-color:rgb(255,255,255);text-decoration-style:initial;text-decoration-color:initial">I assume it can be used to produce PDF and HTML.</div><div style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:12.8px;font-style:normal;font-variant-ligatures:normal;font-variant-caps:normal;font-weight:400;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;background-color:rgb(255,255,255);text-decoration-style:initial;text-decoration-color:initial"><br></div><div style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:12.8px;font-style:normal;font-variant-ligatures:normal;font-variant-caps:normal;font-weight:400;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;background-color:rgb(255,255,255);text-decoration-style:initial;text-decoration-color:initial">--joel</div>
</div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div><div class="h5"><br>
On Wed, Jun 6, 2018 at 11:55 PM, Dannie Huang <<a href="mailto:danxue.huang@gmail.com">danxue.huang@gmail.com</a>> wrote:<br>
> Hi Chris,<br>
><br>
> Code is pushed on my github (link is attached below), it would be great if<br>
> you can review it for me!<br>
><br>
> <a href="https://github.com/dh0072/ReleaseNotesGenerator" rel="noreferrer" target="_blank">https://github.com/dh0072/<wbr>ReleaseNotesGenerator</a><br>
><br>
> I would go to check how Markdown works, thank you!<br>
><br>
> -Dannie<br>
><br>
> On Wed, Jun 6, 2018 at 10:46 PM, Chris Johns <<a href="mailto:chrisj@rtems.org">chrisj@rtems.org</a>> wrote:<br>
>><br>
>> On 07/06/2018 13:40, Dannie Huang wrote:<br>
>> ><br>
>> > Currently data from milestone page and ticket page is stored in python<br>
>> > dictionary,<br>
>><br>
>> This is great. Where is the code so it can be reviewed?<br>
>><br>
>> > how can I convert python dictionary to release notes using sphinx? I<br>
>> > have checked sphinx documentation but not exactly sure how to do it.<br>
>><br>
>> I am not yet sure ReST and Sphinx is the best solution. We need to decide.<br>
>><br>
>> We could use Markdown and get a similar result. The RSB has a Markdown<br>
>> implementation ...<br>
>><br>
>> <a href="https://git.rtems.org/rtems-source-builder/tree/source-builder/sb/markdown" rel="noreferrer" target="_blank">https://git.rtems.org/rtems-<wbr>source-builder/tree/source-<wbr>builder/sb/markdown</a><br>
>><br>
>> Chris<br>
><br>
><br>
><br>
</div></div>> ______________________________<wbr>_________________<br>
> devel mailing list<br>
> <a href="mailto:devel@rtems.org">devel@rtems.org</a><br>
> <a href="http://lists.rtems.org/mailman/listinfo/devel" rel="noreferrer" target="_blank">http://lists.rtems.org/<wbr>mailman/listinfo/devel</a><br>
</blockquote></div><br></div></div>