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.

Sign up for GitHub

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

Jump to bottom

Documentation for OCPP modules #908

Merged
merged 10 commits into from
Oct 25, 2024
Merged

Documentation for OCPP modules #908

merged 10 commits into from
Oct 25, 2024

Conversation

Pietfried
Copy link
Contributor

@Pietfried Pietfried commented Oct 14, 2024 •
edited
Loading

Describe your changes

This PR adds documentation for the existing OCPP modules.

  • Enhanced description of module parameters in manifest.yaml
  • Handwritten module documentation for both OCPP modules picking up all requirements and interfaces provided by the modules
  • Removed provides:empty interface of OCPP201 module. This was not used

Issue ticket number and link

Checklist before requesting a review

  • I have performed a self-review of my code
  • I have made corresponding changes to the documentation
  • I read the contribution documentation and made sure that my changes meet its requirements

@Pietfried Pietfried force-pushed the doc/ocpp-modules branch 2 times, most recently from f10d3e9 to d2379fc Compare October 14, 2024 14:54
@Pietfried Pietfried mentioned this pull request Oct 15, 2024
Merged
3 tasks
hikinggrass
hikinggrass requested changes Oct 15, 2024
View reviewed changes
modules/OCPP/doc.rst Outdated Show resolved Hide resolved
modules/OCPP/doc.rst Outdated Show resolved Hide resolved
modules/OCPP201/doc.rst Outdated Show resolved Hide resolved
Pietfried and others added 4 commits October 15, 2024 20:00
@Pietfried
Updated OCPP module documentation
54c410a 
* Revised existing module documentation
* Moved module documentation to doc.rst files
* Removed unused provides empty of OCPP201 module

Signed-off-by: pietfried <[email protected]>
@Pietfried @hikinggrass
Update modules/OCPP/doc.rst
5a6f84e 
Co-authored-by: Kai Hermann <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried @hikinggrass
Update modules/OCPP201/doc.rst
ffc1b00 
Co-authored-by: Kai Hermann <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Addressed requested changes
f050a76 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried Pietfried requested a review from hikinggrass October 15, 2024 18:01
Pietfried
Pietfried commented Oct 25, 2024
View reviewed changes
modules/OCPP201/doc.rst Outdated Show resolved Hide resolved
Pietfried and others added 3 commits October 25, 2024 15:54
@Pietfried
Update modules/OCPP201/doc.rst
9d349c2 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Minor style changes
1aae8c5 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Minor style changes
770ae0d 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried Pietfried merged commit a46ab61 into main Oct 25, 2024
9 checks passed
@Pietfried Pietfried deleted the doc/ocpp-modules branch October 25, 2024 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hikinggrass hikinggrass hikinggrass approved these changes

@maaikez maaikez Awaiting requested review from maaikez maaikez is a code owner

Assignees

@hikinggrass hikinggrass

@krealyt krealyt

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Pietfried @hikinggrass @krealyt