Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added section of how a user can create a plugin and submit a PR #59

Merged
merged 16 commits into from Apr 27, 2018

Conversation

Projects
None yet
4 participants
@a-stjohn
Copy link
Contributor

commented Mar 22, 2018

No description provided.

@a-stjohn a-stjohn changed the title Added section of how a user can submit a plugin though redmine. Added section of how a user can submit a plugin through redmine. Mar 22, 2018

Deleting Plugins
----------------
Deleting
--------

When you install a plugin, an associated jail is created. If you

This comment has been minimized.

Copy link
@wblock

wblock Mar 29, 2018

Collaborator

Do not use "you". In the second sentence, reword to avoid the if/then construct.

| | with the jail startup, apply configuration settings, |
| | and more. |
+-------------------------+----------------------------------------------------------------------+
| :file:`ui.json` | Json file that accepts the key or value options: |

This comment has been minimized.

Copy link
@wblock

wblock Mar 29, 2018

Collaborator

JSON is an acronym, so capitalize it.

| | The web-interface of the plugin for control and |
| | configuration . |
+-------------------------+----------------------------------------------------------------------+
| :file:`overlay/` | Directory of files copied on top of the jail post-install. |

This comment has been minimized.

Copy link
@wblock

wblock Mar 29, 2018

Collaborator

"on top of" is kind of odd. Into? Overlaid? I would also say "after install" rather than post-install.

| | configuration . |
+-------------------------+----------------------------------------------------------------------+
| :file:`overlay/` | Directory of files copied on top of the jail post-install. |
| | For example, :file:`usr/local/bin/myfile` is placed in the jails |

This comment has been minimized.

Copy link
@wblock

wblock Mar 29, 2018

Collaborator

"jails" is a possessive. Avoid those.

| :file:`overlay/` | Directory of files copied on top of the jail post-install. |
| | For example, :file:`usr/local/bin/myfile` is placed in the jails |
| | /usr/local/bin/myfile location. Can be used to supply custom |
| | files and configuration data, scripts, and more. |

This comment has been minimized.

Copy link
@wblock

wblock Mar 29, 2018

Collaborator

"and more" does not help the reader. Maybe "or ay other type of customized files."

| | /usr/local/bin/myfile location. Can be used to supply custom |
| | files and configuration data, scripts, and more. |
+-------------------------+----------------------------------------------------------------------+
| :file:`settings.json` | Json file that controls plugins settings interface. The required |

This comment has been minimized.

Copy link
@wblock

wblock Mar 29, 2018

Collaborator

JSON.
"plugins settings interface"? Is that a possessive or a plural? It's not clear, either way. "controls" is sort of vague, too.

| | |
| | * :samp:`"servicerestart" : "service plexmediaserver restart"` |
| | |
| | Command to run when restarting service after changing settings. |

This comment has been minimized.

Copy link
@wblock

wblock Mar 29, 2018

Collaborator

s/service/the plugin service/, maybe?

| | |
| | * :samp:`"serviceget" : "/usr/local/bin/myget"` |
| | |
| | Points to the command used to get values for plugin configuration. |

This comment has been minimized.

Copy link
@wblock

wblock Mar 29, 2018

Collaborator

As above, don't use the verb "points". This is just "Command used to..."

| | * :samp:`"serviceget" : "/usr/local/bin/myget"` |
| | |
| | Points to the command used to get values for plugin configuration. |
| | Provided by the plugin creator. Can be any language as long as it |

This comment has been minimized.

Copy link
@wblock

wblock Mar 29, 2018

Collaborator

Does "any language" mean "any programming language" or "any human language"? Not clear what "accepts" means. Is this a runnable command?

| | |
| | * :samp:`"options" : { }` |
| | |
| | This subsection contains arrays of elements, starting with the "key" |

This comment has been minimized.

Copy link
@wblock

wblock Mar 29, 2018

Collaborator

An example would be helpful here.

@a-stjohn a-stjohn requested a review from wblock Apr 3, 2018

+-------------------------+----------------------------------------------------------------------+
| :file:`overlay/` | Directory of files overlaid on the jail after install. |
| | For example, :file:`usr/local/bin/myfile` is placed in the |
| | /usr/local/bin/myfile locationof the jail. Can be used to |

This comment has been minimized.

Copy link
@skarekrow
created and configured a plugins jail.
`PC-BSD 9.x PBIs <http://wiki.pcbsd.org/index.php/AppCafe%C2%AE/9.2>`__.
This allows the installation and configuration of additional
applications of a created jail.

This comment has been minimized.

Copy link
@skarekrow

skarekrow Apr 6, 2018

The plugins architecture has nothing to do with PBIs :)

@a-stjohn a-stjohn changed the title Added section of how a user can submit a plugin through redmine. Added section of how a user can create a plugin and submit a PR Apr 10, 2018

@skarekrow

This comment has been minimized.

Copy link

commented Apr 10, 2018

Ok, Warren can do his thing now :D

@dlavigne dlavigne merged commit 75e5364 into angulargui Apr 27, 2018

@dlavigne dlavigne deleted the angulargui-addition branch May 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.