docs: flesh out plugin documentation #5876
Conversation
Stebalien
commented
Dec 27, 2018
Stebalien
commented
- Flesh out build documentation.
- Add datastore plugins to plugin list.
- Link to example plugin.
- Add a TOC.
* Flesh out build documentation. * Add datastore plugins to plugin list. * Link to example plugin. * Add a TOC. License: MIT Signed-off-by: Steven Allen <steven@stebalien.com>
ghost
assigned 
docs/plugins.md
Outdated
| | [flatfs](https://github.com/ipfs/go-ipfs/tree/master/plugin/plugins/flatfs) | Datastore | x | A stable filesystem-based datastore. | | ||
| | [levelds](https://github.com/ipfs/go-ipfs/tree/master/plugin/plugins/levelds) | Datastore | x | A stable, flexible datastore backend. | | ||
|
|
||
| * **Built-In** plugins are built into the go-ipfs binary and do not need to be |
There was a problem hiding this comment.
This sound more like the deleted In-tree tag. Built-in gives me the impression they are already in the binary and do not need to be loaded at all.
There was a problem hiding this comment.
They are. I've tried to clarify that.
|
|
||
| ##### Other | ||
| ### Preloaded Plugins |
There was a problem hiding this comment.
What does "preloaded" mean in this context? (in contrast with the normal plugin, is it included in the binary?) What's the advantage with respect to just dropping it into the plugins dir?
docs/plugins.md
Outdated
|
|
||
| ## Installing Plugins | ||
|
|
||
| External plugins must be installed in `$IPFS_PATH/plugins/` (usually |
There was a problem hiding this comment.
This paragraph seems to be part of the subsequent External Plugin section.
| myplugin$ go build -buildmode=plugin -i -o myplugin.so myplugin.go | ||
| ``` | ||
|
|
||
| Finally, as with in-tree plugins: |
There was a problem hiding this comment.
nit: this seems pretty much the same as the previous install instructions (mkdir, copy, chmod, restart), maybe we can just point there if there is no substantial difference.
License: MIT Signed-off-by: Steven Allen <steven@stebalien.com>
|
@schomatis can you take another look? Trying to make the preload/external distinction clear. |
