Missing tutorial/Basic Configuration of sharing configuration

[srkunze]

Currently cleaning up my old radicale config. While upgrading, I discovered the new sharing feature! 👍
Right now, I try to make sense of the [sharing] section.

By trial and error, I discovered how to activate it since I could not find anything introductory in the docs or SHARING.md. I think a tutorial/Basic Configuration/few sentences in SHARING.md could help.

Would you accept a pull request?

[AuspeXeu]

Have you managed to share using the web ui? It's a shame such a great feature has no better documentation.

[pbiering]

Have you managed to share using the web ui? It's a shame such a great feature has no better documentation.

Feel free to contribute to Wiki page: https://github.com/Kozea/Radicale/wiki/Sharing-Collections

Me (for the backend) and @maxberger (WebUI) had first to concentrate on implementation and bugfixes.

How it works via API is already documented: https://github.com/Kozea/Radicale/blob/master/SHARING.md#sharing-access-via-maps

[pbiering]

Would you accept a pull request?

Depends on the content, partially it can be better to extend the existing wiki page https://github.com/Kozea/Radicale/wiki/Sharing-Collections or create even a new one.

[srkunze]

Have you managed to share using the web ui? It's a shame such a great feature has no better documentation.

Yes, I did!

You know like we seasoned coders always do such things: mediating over the config file, finding and reading various pieces of documentation, AND, after a large cup of coffee, I finally just randomly turned config variables on and off and refreshed the Web UI frequently. 😂

[srkunze]

@pbiering I see that there multiple docs places for this feature. I found the following:

https://radicale.org/v3.html#sharing
https://github.com/Kozea/Radicale/blob/master/SHARING.md
https://github.com/Kozea/Radicale/wiki/Sharing-Collections

I initially found the first link as this is what Google finds and is referred to frequently all over the Internet.

Depends on the content, partially it can be better to extend the existing wiki page [...] or create even a new one.

From a consumer perspective, I would do the following

• add a subsection for sharing to https://radicale.org/v3.html#basic-configuration
• move/merge SHARING.md to Wiki
• add a new section for a short explanation of the Web UI on https://radicale.org/v3.html

Whatever you approve, I can do.

[pbiering]

Github Wiki content is not part of package, so potentially also not the best destination for API and WebUI documentation.

"DOCUMENTATION.md" which is the source for autogenerated https://radicale.org/v3.html is already very large. Potentially this would be a good trigger to split documentation into several pages and store in "docs" directory and enhance the autogenerator to create multiple HTML pages.

[pbiering]

@AuspeXeu : It's a shame such a great feature has no better documentation.

Are you aware that this open source project has only a few developers doing this all in their leisure time and I'm not aware of any paid or sponsored developer so far where someone else can file demands or expect anything (in-time).

One can be lucky that I overtook the idea after 8 year (#885) and designed a proper backend implementation incl. API and required C*DAV call extensions (I personally do not even need this feature currently) and @maxberger was willing to work on the major extension of the WebUI.

There is some documentation already available, if you mean more is required feel free to contribute by investing parts of your leisure time or wait for others which contribute meanwhile to solve your needs.

See also

• Feature: collection sharing (3.7.0+) #1978
• Contact Birthdays calendar (3.7.0+) #1463

[AuspeXeu]

@pbiering I don't really care for your rant. If I was the developer and I put a lot of energy in writing the code and making it work, I personally would find it a shame if no one can use what I built because it's lacking documentation. This is basically as if I didn't make the effort to implement it at all.

Having said that, my comment was in no way aiming to complain but rather stating that I find it a shame. Which, I appreciate english is not your mother tongue, is in no way attacking anyone. But it seems to me that you have some sort of issue yourself since you interpret it that way. You probably feel underappreciated for your work here. So here it is, Thank you!