Add community "classic" documentation. 📘

[sbernard31]

Maybe wakaama need some common community documentation.

Regarding Github community, it missed not so much :

• Description
• README
• Code of conduct
• Contributing
• License
• Issue templates
• Pull request template
• Repository admins accept content reports

(Maybe even already checked task need to be reviewed)

• We should also add more information about : Security
• Wiki can also be used to add some information (like roadmap, faq ...)
• Remove TODO file in repository and create corresponding issue if needed

Maybe the 1.0 release description needs more love too : https://github.com/eclipse/wakaama/releases/tag/v1.0

Even if this is not perfect you could have a look to Leshan project as inspiration. (or any other eclipse project or popular open source project)
⚠️ About Leshan, all documentation is in wiki which is not a so good idea because often documentation and product as same lifecycle, so maybe this is a better idea to store documentation as markdown files with the code.

[sbernard31]

I changed the License file name this way github is happy (see commit 2c12677)

[sbernard31]

I'm not sure what is the purpose of :https://github.com/eclipse/wakaama/blob/master/TODO ? 🤔

[sbertin-telular]

I'm not sure what is the purpose of :https://github.com/eclipse/wakaama/blob/master/TODO ? 🤔

I'm not sure I've ever looked at that. It is definitely out of date, but does have some good ideas. The following have definitely been implemented, but some of the others might need more investigation.

• JSON support
• Support for Object Link datatype
• Discover method support

[sbernard31]

Maybe we can create corresponding issue for good ideas, then we remove this file ?
Or you think we should keep it ?

[sbertin-telular]

I think creating issues for the good ideas and removing the file would be best. It is too easy to overlook the file.

[sbernard31]

I let you create issues (and maybe labelled it correctly if needed) as you know better than me what are the good idea.
Please let me know when it's done and I will remove the file. 🙏

[sbernard31]

I added more tag to the project : iot, coap, eclipseiot, internet-of-things, device-management.
I slightly changed the project description.
I hide the Package panel (just below Releases) as we don't use it.

[sbernard31]

I enabled the Wiki tab for this project.
So documentation could be added.
Currently the wiki is configured in way that anybody can edit it.
(This is possible to restrict editing to users in teams with push access only)

[sbernard31]

I added a Security Policy : https://github.com/eclipse/wakaama/security/policy
But supported version must be defined. (probably depends on what would be decided in #487)

[sbernard31]

Some improvement on README : #492

[sbernard31]

More improvement on README : #502

[qleisan]

Started the work to document supported features in the wiki. Comments and input is very welcome.

[sbernard31]

About Contributing Guide, I just list some discussions about it :

• Unified block transfer and non-block transfer callbacks. #540 (comment)
• DTLS mode crashes #594 (comment)

[sbernard31]

I see that License is not more detected. License file should be rename like in Leshan to be detected automatically by github.

About Security Policy, GitHub security advisories could be activated if wanted by asking to eclipse IT team move the project in its own organization. (see https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/issues/449)

Maybe could be worthy to have a quick look to already checked tasks ( Description, README, Code of conduct, Contributing) to be sure all information is up to date.

[sbernard31]

(Just in case, I let the link to the Legal Documentation Generator tool of eclipse foundation)