Added information #145
Added information #145
Conversation
Added some additional information on using the Composer autoloader and /src/ in the Directory structure. Please review my interpretation maybe add something on LTS, will old /inc/ be deprecated in the future?
Created an actual RST table :S and added code examples
Should not be in the pull request.
.vscode/settings.json
Outdated
There was a problem hiding this comment.
Forgot to add .vscode to .gitignore obviously xD sorry.
| PRE GLPI 10 | ||
| ++++++++++ | ||
|
|
There was a problem hiding this comment.
This entire paragraph must be removed if it's indeed related to versions prior to GLPI v10.
There was a problem hiding this comment.
This change currently only adds the label. You want me to drop the paragraph or just accept this change from someone else?
But considering my recent rewrite i think it needs a rewrite for glpi11 as well 😅
In that regard, What are the (structuring) rules regarding documenting for various versions. With GLPI11 alot is changing in regards to the folder structure (dropping marketplace, no more front (if done right), etc)
Should the convention documentation only describe the latest (x) versions, only the supported versions, all versions?
There was a problem hiding this comment.
Developers documentation currently only targets GLPI v11.
Changes made in v11 can be marked with a .. versionadded:: 11.0.0 or .. versionchanged:: 11.0.0 and v10 info can be kept - if you want.
But everything older should just be removed (versions are no longer supported).
Co-authored-by: Curtis Conard <[email protected]>
Co-authored-by: Curtis Conard <[email protected]>
About how to use namespaces and composer autoloader in Plugins.
Maybe add information about future support. Will namespaces be the standard and will /inc be deprecated?
I also think it is wise to add the instruction somewhere to "NOT" use existing GLPI classnames inside the plugin namespace or renaming them using:
use GlpiPlugins\Namespace\ExistingObjectName as SomethingElse;. I noticed doing so with extends on other existing GLPI objects like CommonDropdown will make the resulting functionality pretty flaky. It should be easy to come up with unique class names.