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.

Sign up for GitHub

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

Jump to bottom

Improve forge description for generated modules #104

Closed
mateusz-gozdek-sociomantic opened this issue May 30, 2017 · 4 comments
Closed

Improve forge description for generated modules #104

mateusz-gozdek-sociomantic opened this issue May 30, 2017 · 4 comments

Comments

@mateusz-gozdek-sociomantic
Copy link

Currently, when you go to choria/mcollective_agent_puppet page on Puppet Forge, it's almost impossible to find a source of this module, which is problematic when someone wants to contribute to the project.

I think it should be mentioned that those modules are generated automatically from the templates, so description should contain Development section with links to module and template sources.
@ripienaar
Copy link
Member

ripienaar commented May 30, 2017 •
edited
Loading

Note I think the forge homepage and source links are sufficient. We should add a note pointing out its been automatically generated.

Already the README has verbage like "The mcollective_agent_bar module is based on the source from https://github.com/foo/bar." and already it links to the 'Project URL'

This is 2 promininet and obvious places already. The project url is in the metadata.json for computers to find out and the 2nd paragraph in the module tells you where its from.

The reason its confusing is because the foo.ddl files in the agents need fixing so these links point to useful placec

@ripienaar
Copy link
Member

Headsup @mateusz-gozdek-sociomantic I am going to be doing releases any day now to ship the discovery proxy, so if you want this in, nows your chance :)

@mateusz-gozdek-sociomantic
Copy link
Author

OK, I will take care of this soon!

mateusz-gozdek-sociomantic pushed a commit to mateusz-gozdek-sociomantic/puppet-mcollective that referenced this issue Jun 1, 2017
(choria-io#104) Improve README.md template for packaged modules
fa2b46d 
This commit adds to README.md.erb:
  - information that modules are generated automatically
  - link to module templates, so it's easier for people to find and
  contribute to it
mateusz-gozdek-sociomantic pushed a commit to mateusz-gozdek-sociomantic/puppet-mcollective that referenced this issue Jun 1, 2017
(choria-io#104) Improve README.md template for packaged modules
80a0db5 
This commit adds to README.md.erb:
  - information that modules are generated automatically
  - developement section with information, where templates used for
  module generation are stored.
ripienaar added a commit that referenced this issue Jun 1, 2017
@ripienaar
Merge pull request #106 from mateusz-gozdek-sociomantic/issue104-forg…
de27156 
…e-description

(#104) Improve README.md template for packaged modules
@ripienaar
Copy link
Member

thanks a lot @mateusz-gozdek-sociomantic

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ripienaar @mateusz-gozdek-sociomantic