-
Notifications
You must be signed in to change notification settings - Fork 67
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
Update documentation to include Plugin Programming Guide and Plugin Documentation Template #644
Merged
paulbourelly999
merged 8 commits into
develop
from
vh-1337-v2xhub-plugin-documentation-template
Oct 1, 2024
Merged
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
22f3bcc
Update documentation to include Plugin Programming Guide and Plugin D…
paulbourelly999 a378e6f
Updates
paulbourelly999 d63c7fb
Peer Review updates
paulbourelly999 f8ded1f
Updates
paulbourelly999 799e4dc
Updates
paulbourelly999 e16048f
Updates
paulbourelly999 8511f3c
Updates
paulbourelly999 734c201
Updates
paulbourelly999 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
217 changes: 0 additions & 217 deletions
217
examples/tmx-exampleapps/EmptyPlugin/src/EmptyPlugin.cpp
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# SampleBSMPlugin | ||
|
||
This is an example plugin used for demostrating how to develop new **V2X Hub** plugins. Any developed plugin should include accompanying documentation in the form of a `README.md` with the sections outlined here. | ||
|
||
## Documentation Template | ||
|
||
### Introduction | ||
|
||
A brief introduction to the Plugin and the functionality it introduces. Well developed plugins are modular and function independently. | ||
|
||
### Related Plugins | ||
|
||
A list of plugins related to the documented plugin. Often to enable Connected Automated Vehicle (CAV) use-cases, requires multiple **V2X-Hub** plugins running conccurently. This section should described other plugins required for end-user functionality and their role. | ||
|
||
### Configuration/Deployment | ||
|
||
This section should provide documentation about how to configure and deploy the plugin. This should include descriptions of plugin configuration parameters as well as step by step instructions for enabling the plugin. | ||
|
||
### Design (Recommended) | ||
|
||
This is an optional, but recommended section that can be used to outline the high-level design of your plugin. This should include insights into data-flow, communication sequence and relevant data transforms/translations. | ||
|
||
### Messages (Recommended) | ||
|
||
This is an optional, but recommended section that is intended to described the TMX Messages used by the plugin to communicate with other plugins in V2X-Hub | ||
paulbourelly999 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Testing (Recommended) | ||
|
||
This final section is optional, but recommended and is intended to described methods used to confirm the deployed plugin is functioning correctly. This can include testing scripts used to send mock data through the plugin and/or UI status fields to check to confirm working functionality. | ||
paulbourelly999 marked this conversation as resolved.
Show resolved
Hide resolved
|
dan-du-car marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nothing in the sample plugin uses json CPP