Hi all, I see that there's bits of documentation here and there, sometimes it's duplicated in several places: - Source code (README file, server-config.xml description tags, comments inside sh scripts...) - Confluence wiki at apache - WaveProtocol.org site (not sure if I missed any place else?)
This can be a bit confusing, so I suggest deduplicating the documentation. If more people agree with this point of view, I offer myself for the task. My suggestions would be: - Keep docs closely related with code, in the code repository. This prevents version mismatching. E.g. how to build the code, how to configure it, how to run the server... - Keep the rest of stuff in the confluence wiki. This is stuff that will change very rarely. E.g. whitepapers, FAQ, generic user-facing information... - Remove all duplicated docs from waveprotocol.org site. and point to the apache wiki (I'm not sure what's the actual status and purpose of the waveprotocol site?). - Whenever something is moved from the apache wiki to the code repository, provide a link to a browsable version of the relevant repo file. E.g. "For more info, see https://github.com/apache/wave/blob/trunk/README";. Please voice your opinions. If nobody opposes in the next few days, I'll start working on it. All suggestions are welcome :-) -- Saludos, Bruno González _______________________________________________ Jabber: stenyak AT gmail.com http://www.stenyak.com
