From mboxrd@z Thu Jan 1 00:00:00 1970 From: "Erik K." To: documentation@lists.ipfire.org Subject: Re: IPFire Wiki Workflow Date: Sat, 27 Jul 2013 18:50:56 +0200 Message-ID: In-Reply-To: MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="===============4016176541585230090==" List-Id: --===============4016176541585230090== Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Have found another possible wiki guideline list :-) http://wiki.ipfire.org/en/wiki/syntax Am 27.07.2013 um 18:00 schrieb Erik K.: > Hi Michael, > so for the first i think your workflow looks pretty good, but i have some p= ossible enhancements how to extend this workflow.=20 > - The developers and their new developments should become also a part of Po= int (A) i think. Stevee shows a good way how a short developer hand out could= looks like, take a look in here -->http://wiki.ipfire.org/en/configuration/n= etwork/dnsforward . So the coordinator needs to know about this changes too t= hat he can define a priority in the topics. > - In point (B) shouldn=C2=B4t be not also the german translations in there = as a point (2) ? > - The testing of the written articles should be mentioned i think, cause it= is not enough to understand what this software should do, the software needs= to be tested in every single function so a quality management will be done t= oo. > --> I think a new guideline for new and old wikis should be to explain eve= ry function which can be seen on the WUI, this means especially the core deve= lopment or addons where a GUI was also developed by the IPFire team.. > --> Addons with foreign documentations can also become a short docu, but t= hey should be linked to the external wiki/docu. This should also be a part of= a guideline too. >=20 > A question: Should i start as a coordinator to list some important topics ?= Or do we need a little longer ? >=20 > ------------------------ >=20 > A guideline of how to structure the content and the layout of the wiki migh= t be important for the workflow i think. This should prevent that people doin= g very different stuff if they work together in the same sections. So i have = found until now 2 different guidelines for the IPFire wiki.=20 >=20 > - http://wiki.ipfire.org/nonpublic/en/guidelines > - http://wiki.ipfire.org/en/edit EDIT: http://wiki.ipfire.org/en/wiki/syntax >=20 > So some questions to you all regarding to this theme:=20 > - What kind of layout and content structure we should use ?=20 > - What things are missing in those guidelines ? > - To make one good guideline please give some suggestions to them. >=20 > Greetings >=20 > Erik >=20 >=20 >> I drew a little image on how I image the workflow: >> http://wiki.ipfire.org/projects/docs/workflow >>=20 >> Maybe we need to define some things more precisely, but I think this is >> a point were we can start from. >>=20 >> Please post suggestions and critics. >=20 Am 27.07.2013 um 18:00 schrieb Erik K.: > Hi Michael, > so for the first i think your workflow looks pretty good, but i have some p= ossible enhancements how to extend this workflow.=20 > - The developers and their new developments should become also a part of Po= int (A) i think. Stevee shows a good way how a short developer hand out could= looks like, take a look in here --> http://wiki.ipfire.org/en/configuration/= network/dnsforward . So the coordinator needs to know about this changes too = that he can define a priority in the topics. > - In point (B) shouldn=C2=B4t be not also the german translations in there = as a point (2) ? > - The testing of the written articles should be mentioned i think, cause it= is not enough to understand what this software should do, the software needs= to be tested in every single function so a quality management will be done t= oo. > --> I think a new guideline for new and old wikis should be to explain eve= ry function which can be seen on the WUI, this means especially the core deve= lopment or addons where a GUI was also developed by the IPFire team.. > --> Addons with foreign documentations can also become a short docu, but t= hey should be linked to the external wiki/docu. This should also be a part of= a guideline too. >=20 > A question: Should i start as a coordinator to list some important topics ?= Or do we need a little longer ? >=20 > ------------------------ >=20 > A guideline of how to structure the content and the layout of the wiki migh= t be important for the workflow i think. This should prevent that people doin= g very different stuff if they work together in the same sections. So i have = found until now 2 different guidelines for the IPFire wiki.=20 >=20 > - http://wiki.ipfire.org/nonpublic/en/guidelines > - http://wiki.ipfire.org/en/edit >=20 > So some questions to you all regarding to this theme:=20 > - What kind of layout and content structure we should use ?=20 > - What things are missing in those guidelines ? > - To make one good guideline please give some suggestions to them. >=20 > Greetings >=20 > Erik >=20 >=20 >> I drew a little image on how I image the workflow: >> http://wiki.ipfire.org/projects/docs/workflow >>=20 >> Maybe we need to define some things more precisely, but I think this is >> a point were we can start from. >>=20 >> Please post suggestions and critics. >=20 > _______________________________________________ > Documentation mailing list > Documentation(a)lists.ipfire.org > http://lists.ipfire.org/mailman/listinfo/documentation --===============4016176541585230090==--