puppet-library icon indicating copy to clipboard operation
puppet-library copied to clipboard

Added module documentation visualization and fixed haml top bar. Added "--modulepath" option to the library.

Open Moliholy opened this issue 10 years ago • 10 comments

Hello,

in order to have a better visualization of the module in the web page I have added the README.md or README.markdown files included in the own compressed module, and parsed to html using redcarpet library (https://github.com/vmg/redcarpet) to be conveniently shown.

I have also fixed some issues with the top bar, which didn't correctly show the title of the modules.

Best regards, José Molina Colmenero

Moliholy avatar Jul 10 '14 12:07 Moliholy

Thanks @Moliholy, this looks like a good idea. I'd be willing to merge it if you address the comments I made, and if the build passes. At the moment, there are some failing tests for the UI changes, and there are errors on Ruby 1.8.7 from Redcarpet.

drrb avatar Jul 11 '14 07:07 drrb

Done, it should work out now.

Moliholy avatar Jul 11 '14 12:07 Moliholy

After some time trying to figure out the reason the build did not pass, I finally ended up finding the solution: there is no README.md file on the tests, so an exception was raised when trying to read the compressed file. Now of course this has been solved. However, I had to change a bit the spec files to include the new "documentation" part in the JSON that is sent to the client. So, I have created a new build that finally passes (you can find it here: https://travis-ci.org/Moliholy/puppet-library/builds/31919219), but it won't pass yours basically because it does not include the new features' requirements.

Aside from that, I have included a new option called "--modulepath" that, in a nutshell, includes a directory with directly the modules' source, instead of strictly a packed format.

And, finally, links to directly download packed modules depending on the version.

Best regards, José

Moliholy avatar Aug 06 '14 14:08 Moliholy

Coverage Status

Coverage decreased (-3.66%) when pulling 49d102a2805969f6f1fc058251c3a77f84c41494 on Moliholy:master into 1575ff4df1b41da059e8eeb7b0cd9ce59e0cc6bc on drrb:master.

coveralls avatar Aug 08 '14 16:08 coveralls

Coverage Status

Coverage decreased (-3.66%) when pulling aad1b9b928898a87b0c9a47a8e373cd5147b7fae on Moliholy:master into 1575ff4df1b41da059e8eeb7b0cd9ce59e0cc6bc on drrb:master.

coveralls avatar Aug 08 '14 16:08 coveralls

Coverage Status

Coverage decreased (-3.66%) when pulling 6a0d5397a20ea23758b30048ba708e56f234df13 on Moliholy:master into 1575ff4df1b41da059e8eeb7b0cd9ce59e0cc6bc on drrb:master.

coveralls avatar Aug 11 '14 12:08 coveralls

Coverage Status

Coverage decreased (-3.66%) when pulling e0694a1efe5e04a9a4ca37547c0425313d00939d on Moliholy:master into 1575ff4df1b41da059e8eeb7b0cd9ce59e0cc6bc on drrb:master.

coveralls avatar Aug 11 '14 12:08 coveralls

Coverage Status

Coverage decreased (-3.66%) when pulling 5d6b542d7428bc9413c57c18be01dd057720f6a2 on Moliholy:master into 1575ff4df1b41da059e8eeb7b0cd9ce59e0cc6bc on drrb:master.

coveralls avatar Aug 12 '14 13:08 coveralls

Coverage Status

Coverage decreased (-3.48%) when pulling 764e9f43709ecda083f932d50cb38488687919a8 on Moliholy:master into 1575ff4df1b41da059e8eeb7b0cd9ce59e0cc6bc on drrb:master.

coveralls avatar Aug 12 '14 15:08 coveralls

Coverage Status

Coverage decreased (-3.48%) when pulling 764e9f43709ecda083f932d50cb38488687919a8 on Moliholy:master into 1575ff4df1b41da059e8eeb7b0cd9ce59e0cc6bc on drrb:master.

coveralls avatar Aug 12 '14 15:08 coveralls