Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[rdopkg] Port rdopkg ascii docs to markdown #16

Open
chkumar246 opened this issue Jul 25, 2017 · 3 comments
Open

[rdopkg] Port rdopkg ascii docs to markdown #16

chkumar246 opened this issue Jul 25, 2017 · 3 comments
Assignees
Labels

Comments

@chkumar246
Copy link
Contributor

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:

  • Clone the rdopkg repository using git clone https://github.com/softwarefactory-project/rdopkg.
  • Go rdopkg/doc folder, there you can find all the docs files ending with .adoc extension.
  • Install Pandoc using sudo dnf/yum -y install pandoc
  • Read the following blog on how to convert ascii doc to markdow
  • Convert it to mark down and markdown files ends with .md.
  • Once done! Make changes, add and commit it and send a Gerrit Review.
  • Please cross checklist before sending Gerrit Review.

Some links:

Mentors:

  • jruzicka
@yac
Copy link

yac commented Jul 25, 2017

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
Copy link
Contributor

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
Copy link

rbowen commented Aug 2, 2017

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants