Standardized documentation for custom objects
Is there a standard spot to put documentation for custom projects/plugins?
My team is looking into finding an out-of-the-box way to give users a common source for documentation on projects and plugins. This would preferably include a link within UI project views to docs, as well as a common area in the UI where users can browse and search.
I haven't come across anything so far. Plugins have the 'help' that is available via the UI from Administration -> Plugins, but this does not appear to be available from within the project view.
We have a custom plugin solution that uses project properties to display info via an added 'Documentation' tab in the main UI view, but this has high overhead. We would prefer to avoid putting more work into this if a better solution exists.
I'm not ware of any way to do that for projects.
I'm not sure how you create your plugins but the EC-Admin plugin (https://github.com/electric-cloud/EC-Admin) has a procedure named projectAsCode that will create a plugin from a project. If your project as a property named "help", it will create automatically a help page for the plugin. See the EC-Admin help page (generated that way) for details.
Also you could gather all the help pages and link them in a new HTML page referenced a by a new tab/sub-tab. Check http://docs.electric-cloud.com/eflow_doc/6_1/User/HTML/UserflowHTML.htm#custom_editors.htm#Customizing_the_tab_layout to see how to customize views.
