Update README and OCPP 2.0.1 documentation #836

drmrd · 2024-10-15T20:09:02Z

Describe your changes

Updates the main README, standardizing the sections in the 1.6 and 2.0.1 guides.
Moved 1.6 and 2.0.1 content into dedicated README files.
Revised a substantial amount of the 2.0.1 content for clarity and accuracy.
Created a new document that describes how 2.0.1 use cases are implemented in libocpp. The document is currently limited to Smart Charging use cases.
Drafted a Quickstart Guide for 2.0.1. It currently leads the user to set up an environment and run unit tests. Several large sections are left in an HTML comment that guide the user to run a charge_point OCPP client like in the 1.6 Quickstart Guide. These sections are commented out, since such a charge_point doesn't exist currently for 2.0.1.

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
If OCPP 2.0.1: I have updated the OCPP 2.0.1 status document
I read the contribution documentation and made sure that my changes meet its requirements

Signed-off-by: wancen-afs <[email protected]>

curating OCPP 1.6 content only Signed-off-by: wancen-afs <[email protected]>

Curated OCPP 2.0.1 content only Signed-off-by: wancen-afs <[email protected]>

removed unsupported links to white papers and applications Signed-off-by: wancen-afs <[email protected]>

Updated intro text Signed-off-by: wancen-afs <[email protected]>

Update page title and intro text Signed-off-by: wancen-afs <[email protected]>

Simplified content to be more of quick links to each OCPP versions Signed-off-by: wancen-afs <[email protected]>

update URL for md doc Signed-off-by: wancen-afs <[email protected]>

update text Signed-off-by: wancen-afs <[email protected]>

Signed-off-by: wancen-afs <[email protected]>

updated intro text Signed-off-by: wancen-afs <[email protected]>

updated page title Signed-off-by: wancen-afs <[email protected]>

updated intro text Signed-off-by: wancen-afs <[email protected]>

Signed-off-by: wancen-afs <[email protected]>

Added content for OCPP 2.0.1 Signed-off-by: wancen-afs <[email protected]>

added content for OCPP 1.6 Signed-off-by: wancen-afs <[email protected]>

moved content to new folder Signed-off-by: wancen-afs <[email protected]>

Added OCPP 1.6 content Signed-off-by: wancen-afs <[email protected]>

CHANGE PAGE NAME Signed-off-by: wancen-afs <[email protected]>

moved content to new folder Signed-off-by: wancen-afs <[email protected]>

Signed-off-by: wancen-afs <[email protected]>

Updated Development Status section Signed-off-by: wancen-afs <[email protected]>

Signed-off-by: wancen-afs <[email protected]>

Added header banner Signed-off-by: wancen-afs <[email protected]>

Co-authored-by: Dan Moore <[email protected]> Signed-off-by: wancen-afs <[email protected]>

Signed-off-by: wancen-afs <[email protected]>

updated content Signed-off-by: wancen-afs <[email protected]>

updated grammar Signed-off-by: wancen-afs <[email protected]>

updated readme title to match ocpp 2.0.1 readme Signed-off-by: wancen-afs <[email protected]>

Co-authored-by: Dan Moore <[email protected]> Signed-off-by: wancen-afs <[email protected]>

Updated table of contents Signed-off-by: wancen-afs <[email protected]>

updated ocpp 2.0.1 table of contents Signed-off-by: wancen-afs <[email protected]>

Signed-off-by: Daniel Moore <[email protected]>

wancen-afs added 30 commits October 15, 2024 16:06

Create OCPP-1-6.md

7dd9249

Signed-off-by: wancen-afs <[email protected]>

Create OCPP-2-0-1.md

dc8e511

Signed-off-by: wancen-afs <[email protected]>

Update OCPP-1-6.md

d2907b4

curating OCPP 1.6 content only Signed-off-by: wancen-afs <[email protected]>

Update OCPP-2-0-1.md

8cd4183

Curated OCPP 2.0.1 content only Signed-off-by: wancen-afs <[email protected]>

Update OCPP-1-6.md

af1fb71

removed unsupported links to white papers and applications Signed-off-by: wancen-afs <[email protected]>

Update OCPP-1-6.md

de8b629

Updated intro text Signed-off-by: wancen-afs <[email protected]>

Update OCPP-1-6.md

58f8b78

Update page title and intro text Signed-off-by: wancen-afs <[email protected]>

Update README.md

90795e2

Simplified content to be more of quick links to each OCPP versions Signed-off-by: wancen-afs <[email protected]>

Update README.md

c65af3b

update URL for md doc Signed-off-by: wancen-afs <[email protected]>

Update README.md

007d50e

update text Signed-off-by: wancen-afs <[email protected]>

Update OCPP-2-0-1.md

2b5d7cb

Signed-off-by: wancen-afs <[email protected]>

Update README.md

814f48b

updated intro text Signed-off-by: wancen-afs <[email protected]>

Update README.md

dffbdf4

updated page title Signed-off-by: wancen-afs <[email protected]>

Update OCPP-2-0-1.md

44ddabd

updated page title Signed-off-by: wancen-afs <[email protected]>

Update OCPP-1-6.md

c568d47

updated page title Signed-off-by: wancen-afs <[email protected]>

Update README.md

9ace145

updated intro text Signed-off-by: wancen-afs <[email protected]>

Create ocpp_201_readme.md

398963e

Signed-off-by: wancen-afs <[email protected]>

Create ocpp_16_readme.md

66dcb48

Signed-off-by: wancen-afs <[email protected]>

Update ocpp_201_readme.md

ec916cd

Added content for OCPP 2.0.1 Signed-off-by: wancen-afs <[email protected]>

Update ocpp_16_readme.md

d6b4097

added content for OCPP 1.6 Signed-off-by: wancen-afs <[email protected]>

Delete OCPP-2-0-1.md

26b8294

moved content to new folder Signed-off-by: wancen-afs <[email protected]>

Delete doc/ocpp_16_readme.md

a436cdf

moved content to new folder Signed-off-by: wancen-afs <[email protected]>

Create ocpp_16_README.md

341185a

Added OCPP 1.6 content Signed-off-by: wancen-afs <[email protected]>

Rename ocpp_201_readme.md to ocpp_201_README.md

f473fb7

CHANGE PAGE NAME Signed-off-by: wancen-afs <[email protected]>

Delete OCPP-1-6.md

fa2a005

moved content to new folder Signed-off-by: wancen-afs <[email protected]>

Create banner-ocpp.jpg

01ff08d

Signed-off-by: wancen-afs <[email protected]>

Add files via upload

44e038c

Signed-off-by: wancen-afs <[email protected]>

Update README.md

be1b13a

Updated Development Status section Signed-off-by: wancen-afs <[email protected]>

Add files via upload

348dd5b

Signed-off-by: wancen-afs <[email protected]>

Update README.md

a250f83

Added header banner Signed-off-by: wancen-afs <[email protected]>

wancen-afs and others added 24 commits October 15, 2024 16:06

Update doc/ocpp_201_README.md

fd25e70

Co-authored-by: Dan Moore <[email protected]> Signed-off-by: wancen-afs <[email protected]>

Update doc/ocpp_201_README.md

e8002bb

Co-authored-by: Dan Moore <[email protected]> Signed-off-by: wancen-afs <[email protected]>

Update doc/ocpp_201_README.md

ef3e2fb

Co-authored-by: Dan Moore <[email protected]> Signed-off-by: wancen-afs <[email protected]>

Update doc/ocpp_201_README.md

9c0119e

Co-authored-by: Dan Moore <[email protected]> Signed-off-by: wancen-afs <[email protected]>

Update doc/ocpp_201_README.md

3055a25

Co-authored-by: Dan Moore <[email protected]> Signed-off-by: wancen-afs <[email protected]>

Update ocpp_16_README.md

38e7c00

Signed-off-by: wancen-afs <[email protected]>

Update ocpp_201_README.md

770e931

Signed-off-by: wancen-afs <[email protected]>

Update ocpp_201_README.md

2a46305

updated content Signed-off-by: wancen-afs <[email protected]>

Update ocpp_16_README.md

f6f4846

updated grammar Signed-off-by: wancen-afs <[email protected]>

Update ocpp_16_README.md

610a4ee

updated readme title to match ocpp 2.0.1 readme Signed-off-by: wancen-afs <[email protected]>

Update doc/ocpp_201_README.md

f030ac2

Co-authored-by: Dan Moore <[email protected]> Signed-off-by: wancen-afs <[email protected]>

Update doc/ocpp_201_README.md

c8233fe

Co-authored-by: Dan Moore <[email protected]> Signed-off-by: wancen-afs <[email protected]>

Update doc/ocpp_201_README.md

7cb3470

Co-authored-by: Dan Moore <[email protected]> Signed-off-by: wancen-afs <[email protected]>

Update doc/ocpp_201_README.md

7e3b272

Co-authored-by: Dan Moore <[email protected]> Signed-off-by: wancen-afs <[email protected]>

Update doc/ocpp_201_README.md

cc61f36

Co-authored-by: Dan Moore <[email protected]> Signed-off-by: wancen-afs <[email protected]>

Update doc/ocpp_201_README.md

748b946

Co-authored-by: Dan Moore <[email protected]> Signed-off-by: wancen-afs <[email protected]>

Update doc/ocpp_201_README.md

b18fb24

Co-authored-by: Dan Moore <[email protected]> Signed-off-by: wancen-afs <[email protected]>

Update ocpp_201_README.md

19fd0c1

Updated table of contents Signed-off-by: wancen-afs <[email protected]>

Update README.md

dd25107

updated ocpp 2.0.1 table of contents Signed-off-by: wancen-afs <[email protected]>

Finish a basic "Quickstart Guide" for OCPP 2.0.1

afe5d96

Signed-off-by: Daniel Moore <[email protected]>

Omit future-facing sections of 2.0.1 Quickstart Guide

37facb9

Signed-off-by: Daniel Moore <[email protected]>

Move 2.0.1 use case documentation into a dedicated guide

1e2f4e0

Signed-off-by: Daniel Moore <[email protected]>

Update highlight color in use case diagrams

31c5d4e

Signed-off-by: Daniel Moore <[email protected]>

Update config.json path in 2.0.1 README

b5f18dd

Signed-off-by: Daniel Moore <[email protected]>

drmrd requested review from Pietfried, hikinggrass, marcemmers and maaikez as code owners October 15, 2024 20:09

This was referenced Oct 23, 2024

Documentation: Refactoring of the README #842

Open

Refactored libocpp documentation #847

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update README and OCPP 2.0.1 documentation #836

Update README and OCPP 2.0.1 documentation #836

drmrd commented Oct 15, 2024 •

edited

Loading

Update README and OCPP 2.0.1 documentation #836

Are you sure you want to change the base?

Update README and OCPP 2.0.1 documentation #836

Conversation

drmrd commented Oct 15, 2024 • edited Loading

Describe your changes

Issue ticket number and link

Checklist before requesting a review

drmrd commented Oct 15, 2024 •

edited

Loading