Skip to content

Conversation

Moliholy
Copy link

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

@@ -41,6 +41,7 @@ Gem::Specification.new do |spec|
spec.add_dependency "haml"
spec.add_dependency "docile", ">= 1.0.0"
spec.add_dependency "open4"
spec.add_dependency "redcarpet"
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@drrb
Copy link
Owner

drrb commented Jul 11, 2014

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.

@Moliholy
Copy link
Author

Done, it should work out now.

@@ -24,6 +24,12 @@
$(document).ready(function() {
var source = "modules.json#{ query.nil? ? '' : '?q=' + query }";
$.getJSON(source, function(modules) {
modules.sort(function(a, b){
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It sorts all modules by full name. I tried to do it in the server but because of problems with ruby versions it ended up being a pain in the neck, so it's finally the client who is going to do it.

@Moliholy
Copy link
Author

Moliholy commented Aug 6, 2014

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 Moliholy changed the title Added module documentation visualization and fixed haml top bar Added module documentation visualization and fixed haml top bar. Added "--modulepath" option to the library. Aug 7, 2014
@Moliholy Moliholy changed the title Added module documentation visualization and fixed haml top bar. Added "--modulepath" option to the library. Added module documentation visualization and fixed haml top bar. Added "--modulepath" option to the library. Added download link for packed modules. Aug 7, 2014
@@ -22,4 +22,9 @@
%div= "Versions:"
%ul
- metadata["releases"].each do |release|
%li= release["version"]
%li
%a{:href => "/modules/#{metadata["author"]}-#{metadata["name"]}-#{release["version"]}.tar.gz"} #{release["version"]}
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It creates a link to download the packed modules in the version number.

@coveralls
Copy link

Coverage Status

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

@coveralls
Copy link

Coverage Status

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

@coveralls
Copy link

Coverage Status

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

@coveralls
Copy link

Coverage Status

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

@coveralls
Copy link

Coverage Status

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

@Moliholy Moliholy changed the title Added module documentation visualization and fixed haml top bar. Added "--modulepath" option to the library. Added download link for packed modules. Added module documentation visualization and fixed haml top bar. Added "--modulepath" option to the library. Aug 12, 2014
@coveralls
Copy link

Coverage Status

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

@coveralls
Copy link

Coverage Status

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

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

Successfully merging this pull request may close these issues.

3 participants