Code of Conduct

Hi and welcome as a new Author to this system.  We're not going to pull you of you horse with a million little rules you need to comply, rather the opposite; since there are a lot of us happily co-working here we would want to show you which simple rules of conduct make sure your (and our) work is not wasted over here, and the collaboration keeps being as frustration-free as possible.

When in doubt: just ask and discuss.

Not sure why somebody changed something? You though some other wording was better? You miss something being at a certain spot in the structure?

Don't let things get on your nerves, and definitely don't use this collaborate system to fight some re-overwrite-war.

Instead use email (via the mailing-list at discuss@restlet.tigris.org) and just ask for clarification, Come to a consensus first and then come back here and comply to that agreement.

Check changes.

With various people contributing to this system in parallel, you easily get lost of who is doing what and what is changing where. To help you keep an overview there are various ways to stay on top of what is changing over here:

  1. notification emails are sent to commits@restlet.tigris.org
  2. you can register yourself for notification emails via
    • Actions > Subscribe (single page)
    • User > User Settings
  3. via the menu you can access the 'recent changes' page
  4. there you will also find some

Note also that for every page you view there is a Actions > Changes view in the menu that will show you the version-by-version change on that particular document.

Leave 'fixme's to pull in others.

We don't expect every author to know all the answers.  Actually quite the opposite: you clearly stating to be unsure about certain things actually improves documentation (as it warns the reader about possible miss-interpretations.)

The easy way to mark your doubts is to simply leave a paragraph labelled with the 'fixme' style inside your text.

Other author will easily spot those, and might happily complete the missing details.

Out of ideas?

I think we should provide a living page that lists TODO's and urgencies... what do others think? where should it go? How do we handle it?

Comments (0)
Navigation doc: view