search

eclipse-wakaama / wakaama

Eclipse Wakaama is a C implementation of the Open Mobile Alliance's LightWeight M2M protocol (LWM2M).
BSD 3-Clause "New" or "Revised" License
492 stars 373 forks source link

Add community "classic" documentation. 📘 #491

Open sbernard31 opened 3 years ago

sbernard31 commented 3 years ago

Maybe wakaama need some common community documentation.

Regarding Github community, it missed not so much :

(Maybe even already checked task need to be reviewed)

~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) :warning: 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 commented 3 years ago

I changed the License file name this way github is happy (see commit https://github.com/eclipse/wakaama/commit/2c126779844a0b4086fb7600135ede492854227f)

sbernard31 commented 3 years ago

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

sbertin-telular commented 3 years ago

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.

sbernard31 commented 3 years ago

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

sbertin-telular commented 3 years ago

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

sbernard31 commented 3 years ago

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. :pray:

sbernard31 commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

Some improvement on README : #492

sbernard31 commented 3 years ago

More improvement on README : #502

qleisan commented 3 years ago

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

sbernard31 commented 3 years ago

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

sbernard31 commented 11 months ago

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 commented 10 months ago

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