Page MenuHomePhabricator

How can I edit the documentation?
OpenPublic

Asked by MuratUrsavas on Mar 16 2016, 8:36 AM.

Details

First of all, Phabricator is a really wonderful set of tools. Congratulations to the guys behind it (starting with @epriestley).

I've installed it and surprised how well detailed the documentation and guides are (even they are labeled as WIP). It was directing me to the right way from the beginning (with setup issues and their solutions). Last day I've managed to host a repo with git but it was really time consuming (as told in docs). It was not Phabricator, but my ignorance. I've managed to find the correct way with Diffusion Repo Hosting doc but one thing was missing. It was the addition of the private key to the client side ssh keys. It could be very obvious for many developers but it was not that obvious for me (pffft, typical newbie :).

So adding this simple line could save many minutes of frustration for the newcomers.

Coming to the original question:
How can I edit the documentation, so I can help at least a bit? The contribution introduction was not mentioning docs.

Regards,
// Murat

Answers

epriestley
Updated 2,962 Days Ago

We'd prefer you file a bug report (for misleading/incorrect documentation) or feature request (for missing documentation), describe the problem you ran into, and then let us decide how to fix it.

Sometimes editing the documentation is the right way forward, but sometimes we can reorganize it instead, add a setup check or better error checking, prevent the issue in the first place, etc.

Documentation has a maintenance cost and it tends to get out of date pretty fast, and is one of the least effective solutions available to many problems (that is, it's much better if the software prevents you from making a bad configuration, detects a bad configuration, or works in the presence of a configuration than if the only way to move forward is to find the right piece of documentation), so we want to understand problems and look for other ways to prevent or work around them before we use documentation as a fix.

New Answer