Contributing to the Bitbucket Documentation
Would you like to share your Bitbucket hints, tips and techniques with us and with other Bitbucket users? We welcome your contributions.
Writing new and updating existing Bitbucket documentation
Have you found a mistake in the documentation, or do you have a small addition that would be so easy to add yourself rather than asking us to do it? You can update the documentation page directly.
Getting update rights on the documentation
We do ask you to sign the Atlassian Contributor License Agreement (ACLA) before we grant you wiki permissions to update the documentation space. Please read the ACLA to see the terms of the agreement and the documentation it covers. Then sign and submit the agreement as described on the form linked to that page.
Following our Style Guide
Please read our short guidelines for authors
How we Manage Community Updates
Here is a quick guide to how we manage community contributions to our documentation and the copyright that applies to the documentation:
- Monitoring by technical writers. The Atlassian technical writers monitor the updates to the documentation spaces, using RSS feeds and watching the spaces. If someone makes an update that needs some attention from us, we will make the necessary changes.
- Wiki permissions. We use wiki permissions to determine who can edit the documentation spaces. We ask people to sign the Atlassian Contributor License Agreement (ACLA) and submit it to us. That allows us to verify that the applicant is a real person. Then we give them permission to update the documentation.
- Copyright. The Atlassian documentation is published under a Creative Commons CC BY license. Specifically, we use a Creative Commons Attribution 2.5 Australia License. This means that anyone can copy, distribute and adapt our documentation provided they acknowledge the source of the documentation. The CC BY license is shown in the footer of every page, so that anyone who contributes to our documentation knows that their contribution falls under the same copyright.
Adding your Tips to hg tip
Add your beginner's or advanced tips at hg tip, a repository of short, easy-to-understand tips for using Mercurial. The site is published from a repository at Bitbucket. See the guide to contributing.
Blogging your Technical Tips and Guides – Tips of the Trade
Have you written a blog post describing a specific configuration of Bitbucket or a neat trick that you have discovered? Let us know, and we will link to your blog from our documentation. More....
Contributing Documentation in Other Languages
Have you written a guide to Bitbucket in a language other than English, or translated one of our guides? Let us know, and we will link to your guide from our documentation. More....
Hosting your Guides on Bitbucket
You can use Bitbucket as a site to publish your own documentation as a static website. A great example is Mercurial: The Definitive Guide by Bryan O'Sullivan. Another example is the TortoiseHg documentation.
See our guide to Publishing a Website on Bitbucket.
Was this helpful?
Thanks for your feedback!