Ask Your Question
0

How can I add custom type documentation for the forge?

asked 2015-01-24 05:36:54 -0500

Stefan gravatar image

updated 2015-01-24 05:38:18 -0500

I finally took the time to upload a few of my modules to the forge. Most of them are custom types. So I created a metadata.json file and according to the documentation puppet module build should then populate the types field with the inlinedocumentation of the custom types.

This doesn't really happen as you can see here: stschulte/rpmkey What I would like to have is something like godp1301/postgresql where you have an additional "types" tab. How can I do that?

edit retag flag offensive close merge delete

1 answer

Sort by ยป oldest newest most voted
1

answered 2015-01-28 22:05:22 -0500

GregLarkin gravatar image

updated 2015-01-30 19:09:54 -0500

It's possible that the types tab on the module page is deprecated and no longer supported. According to the documentation, the types field in metadata.json is deprecated.

I checked some of the puppetlabs-* modules that implement custom types (e.g. https://forge.puppetlabs.com/puppetlabs/postgresql - the upgraded version of the module you referenced), and none of their module pages include the types tab, leading me to believe that it's a deprecated feature on the Forge.

UPDATE: I was mistaken. The Forge will start autogenerating the types information from modules RSN. Once that starts happening, the types tab will reappear.

edit flag offensive delete link more

Comments

thanks. I noticed that the "types" tab is now appearing on a few modules.

Stefan gravatar imageStefan ( 2015-02-03 17:11:43 -0500 )edit

Good to hear!

GregLarkin gravatar imageGregLarkin ( 2015-02-05 21:29:27 -0500 )edit

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Question Tools

1 follower

Stats

Asked: 2015-01-24 05:36:54 -0500

Seen: 72 times

Last updated: Jan 30 '15