Hi all
currently our documentation for upcoming developers is spread over different places:
[1] FAQ 7.3 in Documentation [2] Developers section in Documentation [3] http://www.phpmyadmin.net/home_page/devel.php [4] wiki
What I'd like to do is to move most information to website [3], with possible more detailed information on wiki [4] and removing almost all content from Documentation [1],[2].
Currently it is quite hard to keep the information up to date [*] and I don't think it makes much sense to provide information in the documentation for offline usage as you would anyway require to be online to contribute.
I've just submitted pull request for this change on github, so feel free to comment it there:
https://github.com/phpmyadmin/phpmyadmin/pull/1
[*]: I think that [2] will become really outdated on our way to 4.0.
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1
Le 2012-02-13 07:58, Michal ?iha? a écrit :
Hi all
currently our documentation for upcoming developers is spread over different places:
[1] FAQ 7.3 in Documentation [2] Developers section in Documentation [3] http://www.phpmyadmin.net/home_page/devel.php [4] wiki
What I'd like to do is to move most information to website [3], with possible more detailed information on wiki [4] and removing almost all content from Documentation [1],[2].
Good idea, but why not put most information on the wiki? Maybe more static info should go to website and more dynamic one, to the wiki?
Currently it is quite hard to keep the information up to date [*] and I don't think it makes much sense to provide information in the documentation for offline usage as you would anyway require to be online to contribute.
I've just submitted pull request for this change on github, so feel free to comment it there:
https://github.com/phpmyadmin/phpmyadmin/pull/1
[*]: I think that [2] will become really outdated on our way to 4.0.
- -- Marc Delisle http://infomarc.info
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA256
Hi
Dne Mon, 13 Feb 2012 09:57:54 -0500 Marc Delisle marc@infomarc.info napsal(a):
Good idea, but why not put most information on the wiki? Maybe more static info should go to website and more dynamic one, to the wiki?
Well I don't think website should contain more information than it currently does. Rest should be put into wiki (I've put there all what was included in documentation for now).
- -- Michal Čihař | http://cihar.com | http://blog.cihar.com
On 13/02/2012 16:01, Michal Čihař wrote:
Hi
Dne Mon, 13 Feb 2012 09:57:54 -0500 Marc Delisle marc@infomarc.info napsal(a):
Good idea, but why not put most information on the wiki? Maybe more static info should go to website and more dynamic one, to the wiki?
Well I don't think website should contain more information than it currently does. Rest should be put into wiki (I've put there all what was included in documentation for now).
Hi,
The website (devel/contribute page) is an entry point for new developers and should point to the wiki for detailed (and up to date) information.
Kind regards,
Dieter
-
Dieter Adriaenssens -
Marc Delisle -
Michal Čihař