2020-09-22 08-54-09
Ajay Sharma
Champion
Forge plugins should have proper instructions to use that plugin
1450
Views
17
Comments
Implemented
Forge

Every plugin should have basic steps to use plugin.

Like GIT website 

2019-04-01 12-11-28
Craig St.Jean
mvp_badge
MVP

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?

2020-09-22 08-54-09
Ajay Sharma
Champion

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.

2019-11-12 17-31-26
Justin James
mvp_badge
MVP

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

J.Ja

2019-04-01 12-11-28
Craig St.Jean
mvp_badge
MVP

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)
2022-07-06 03-36-19
Hanno
mvp_badge
MVP

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
Changed the status to
Implemented
on 06 Jun 2019

Hi, Ajax! Your idea was released two months after, but I've noticed that it has never been marked as implemented. I'm doing it now! Since then, I hope you've been using and taking advantage of the Documentation tab! ;) 

Keep the ideas coming.

Ângela

Merged this idea with 'Forge - Create an area for documentation' (created on 06 Jun 2019 09:32:55 by Alberto Ferreira)

It could be nice if the forge page have one specific space to add documentation about the use of the component. If possible that can generate a pdf for download.


However it could be optional, but encouraged.


 

Changed the category to
Community Forge
and the status to
Working on it
expected delivery in Q3 2019

Hi Alberto,

Thank you for sharing this idea. We are working on it.

Cheers

Daniela

2022-07-06 03-36-19
Hanno
mvp_badge
MVP

Hmmm. You can see the future, Alberto?

Thanks for your feedback Daniela

Regards

2020-04-15 12-37-36
Daniël Kuhlmann
mvp_badge
MVP

If it are the component team members that are supposed to add the documentation, then I think this idea is already recently implemented. I uploaded yesterday a component and there is now a documenation section that can be filled out. It shows as the last tab on the component in the forge.

Changed the status to
Implemented
on 31 Jul 2019

Thank you for your suggestion, the idea is implemented. 

Keep sending more ideas, we are listening.


Thanks. Nice to know

Regards