redhat-openstack / easyfix

6 stars 5 forks source link

[rdopkg] Port rdopkg ascii docs to markdown #16

Open chkumar246 opened 7 years ago

chkumar246 commented 7 years ago

Currently rdopkg docs are written in ascii. we wanted to port it to markdown so that we can integrate it with RDO Project website.

How to proceed:

Some links:

Mentors:

yac commented 7 years ago

asciidoc is a markdown flavor I chose because it generates both nice man page and HTML.

Instead of blindly converting .adoc to .md I'd rather see how exactly we're gonna integrate this into RDO webpage without breaking separate man pages output and only change things to achieve this integration.

snecklifter commented 7 years ago

How does the content on the RDO website get updated going forwards? One of the main issues with the RDO website is that the content quickly goes out of date.

rbowen commented 7 years ago

All content on the RDO website is in https://github.com/redhat-openstack/website ... but you already knew that, having contributed changes to that. Any time that there's content that's duplicated on the RDO site, it's always better to just link to the upstream canonical version of the content. We don't want to have copies that have to be separately maintained.