1
 Follower
5
 Likes

Forge plugins should have proper instructions to use that plugin

Community Forge
New

Every plugin should have basic steps to use plugin.

Like GIT website 

Created on 8 Apr
Comments (8)

Hey Ajay,

I certainly agree, but as the Forge is community driven how do you propose the system be enhanced to ensure plugins are appropriately documented?

Hi Craig,

Thanks for agreeing

I recommend a form to be filled by developer who is uploading plugin.

Form should have required fields with basic questions and there must be a reviewer who can review plugin before going to Forge.

How much are you paying the Forge component developers to do this?

J.Ja

Also, I want to point out that GitHub (as you referenced) does not require any kind of instructions.  If someone adds a Readme document to their repository, it displays it, but there is nothing forcing developers to put something there.

Is there a specific component that you have in mind?  You can always request to join a component's team and add any documentation that is missing.

Merged this idea with 'How-To Section for each Forge Component' (created on 23 May 2019 20:06:56 by Hanno)

I think that a "How-To" section for each component on the forge could be a great help. Almost like the documentation for the OutSystems platform, with a hierarchy of class/function/object/properties/methods etc.

It will serve as a form of documentation with workable examples and will be indexed by search engines, which I think will greatly help the community. The current way of having a demo project or Try Now link does not seem to cater to everyone's need.




This comment was:
- originally posted on idea 'How-To Section for each Forge Component' (created on 23 May 2019 by Hanno)
- merged to idea 'Forge plugins should have proper instructions to use that plugin' on 27 May 2019 10:44:49 by Sofia Modesto

Changed the category to Community Forge




This comment was:
- originally posted on idea 'How-To Section for each Forge Component' (created on 23 May 2019 by Hanno)
- merged to idea 'Forge plugins should have proper instructions to use that plugin' on 27 May 2019 10:44:49 by Sofia Modesto

Changed the category to Community Forge


views
142
Followers
1