Documentation August 2013

documentation@lists.ipfire.org

9 participants
26 discussions

Hey guys...
by Michael Tremer 10 Aug '13

10 Aug '13

Hey guys, on Thursday, Erik sent an email to the Core Developers which said that he won't have the time to work on the project, because of personal reasons and that his job requires him to travel a lot in the near future. He was the Wiki Coordinator [1] and we have currently been working on organizing the people who work on the documentation in a better way. The goal was to raise everybody's awareness about what there is to do, so that we work together as best as possible. As more and more volunteers have shown up in the last weeks and month, (which I am very happy about, by the way) I think that it is becoming more and more important that the documentation team will finally become a real "team", which more than just one person. As long as we don't have a coordinator, I wouldn't like seeing things going down, so that I am going to take the role for a little while, until we found solutions for the problems we need to sort out. This is not intended to go on for more than one or two weeks. What are those problems? * We started working on a so called "workflow" [2], which should help to keep us all on the "same page" - almost literally. * We are planning to build translation teams, so that the documentation team and the group of translations are completely independent. This only makes sense, because they always work independently and status of the translations also varies a lot. I am still undecided on how we should handle this, so please feel free to send me ideas or opinions on this list. * We have got a whole bunch of things to do at the moment. A lot of new functionality has been added to the distribution and for parts of that there is no documentation at all. So, there is a lot of chaos going on here right now. Now you know the reasons and I would be happy if we could solve this all together very soon. -Michael [1] http://wiki.ipfire.org/projects/docs/start [2] http://wiki.ipfire.org/projects/docs/workflow

2 3

Translate VLAN with IPFire
by Thomas Berthel 09 Aug '13

09 Aug '13

Hi, i have translate the documentation on "VLAN", here: in German -> http://wiki.ipfire.org/de/optimization/vlan/start to english here -> http://wiki.ipfire.org/en/optimization/vlan/start Can someone check this times? Thanks. greetings, Thomas

2 1

VLAN Konfig
by Thomas Berthel 08 Aug '13

08 Aug '13

Hi zusammen, ich habe hier: http://wiki.ipfire.org/de/optimization/vlan/start die Doku für das VLAN fertig gestellt, könnte das jemand von euch in ein brauchbares Format für die englisch sprechenden Uer vorbereiten. Korregturen dürfen natürlich ebenso vorgenommen werden ;-) Ein schönes Wochenende! Thomas

4 17

Changes into Testing tree Wiki
by Thomas Berthel 08 Aug '13

08 Aug '13

Hi, i have expanded documentation on "change out from testing tree", here: in German -> http://wiki.ipfire.org/de/configuration/ipfire/pakfire/testing and in english -> http://wiki.ipfire.org/en/configuration/ipfire/pakfire/testing Can someone check this times? Thanks. greetings, Thomas

3 3

Documentation-workflow
by SCHUH Karl, SCHUH-TV 08 Aug '13

08 Aug '13

Hi Erik, thank you for your mail about the documentation-workflow, but I still don't get it :-( The table says about "DNS forwarding", that translation should be done. On the other hand it (and the document itself) say, that this doc is in stage B, which means "authoring"? :-/ How shall I interpret this? Best regards, Karl -- Ing. Karl SCHUH Hauptstraße 23a A-7434 Bernstein +43(664)38 06 107

3 5

Why IPFire does not run on all ARM hardware...
by R. W. Rodolico 07 Aug '13

07 Aug '13

First, Michael, thank you for the excellent article. It was longer than normal, but well worth the read. I now understand why the ARM stuff is such a pain in the rear. Some of the articles are definitely transient (ie, new release, stuff like that), but articles like this are not. I was wondering if there is a need to place that article (and possibly others like it) in the documentation site. Under a special section? Rod -- R. W. "Rod" Rodolico Daily Data, Inc. POB 140465 Dallas TX 75214-0465 http://www.dailydata.net 214.827.2170

2 1

GPG wiki
by Erik K. 06 Aug '13

06 Aug '13

Hi all, i want to introduce the first translation of the GPG wiki to english --> http://wiki.ipfire.org/en/optimization/scripts/gpg/start . This wiki is in the beginning of state (B) of the wiki workflow --> http://wiki.ipfire.org/projects/docs/workflow . Please go for some checks on that. Greetings Erik

5 13

Re: Documentation-workflow
by Erik K. 06 Aug '13

06 Aug '13

Hi Karl, Am 06.08.2013 um 10:02 schrieb SCHUH Karl, SCHUH-TV: > Hi Erik, > I understand, that the list on the todo-page is not finished yet, but I still don't know, if someone should start translating the DNS-forwarding immediately or not? If the list contains only sampla-data, it should be noted so (in "warning"-box). The data in the list are no sample-data, so indeed a translation should be done immediately. > If the list contains first, but true, data, it should be synchronized to the workflow-satus (you say it is in C or D, but the list and the document still say B). As I said earlier, it would be nice to see who was the author and who revied the document (could be one or two lines in the head or foot of a document). Good idea, so it is possible to see who reads through or made some corrections in which state of the workflow. A good location for this is the foot of the document i think. Another category can be if the explained functions was tested or not. > > I agree with you, that ideas should be collected from anyone and that it would be nice to know who did what. But I don't think, that a spreadsheet is a good soluton since it is too easy to change something by mistake. Do you think the chance for mistakes are relevant ? > > I also ask you to think about a sort of "owner" for the primary-language-page and for each translation. These owners could be contacted, if someone wanted to do some changes. If you click into the sidemenu of each wiki page you can find the option "old revisions" in there you can overlook all the changes and the authors who did the changes. This function can be used for this for example. > > Maybe we should also have a glossary of words, we do not translate (server, port, client .......) I don´t understand the intend for this, may you can explain it a little more. > > Greetings, > Karl Greetings Erik > > Hi Karl, > this list was a first idea of how the working progress can be listed. So the list isn´t finished until now, it might be important to find a good harmony also in relation to the workflow. The next step should be to figure a good way out for a spreadsheet, where all are invited to advect new ideas. For example if someone did some work on the wiki he can comment it in there what was done or what should be done in a closer future. Also a list of wikis which should be revised can be a good idea. But there is surely more. > > The DNS forwarding wiki is meanwhile in phase (C) or may (D), but it is important to know what work was done until now, how many people did a review on that page and so on. As you see the workflow and a potential ToDo list is in the beginning and possibly a discussion with more ideas to this theme will come. > > Greetings > > Erik > > > > Am 05.08.2013 um 19:18 schrieb SCHUH Karl, SCHUH-TV: > > Hi Erik, > thank you for your mail about the documentation-workflow, but I still don't get it :-( > > The table says about "DNS forwarding", that translation should be done. On the other hand it (and the document itself) say, that this doc is in stage B, which means "authoring"? :-/ > > How shall I interpret this? > > Best regards, > Karl > > -- > Ing. Karl SCHUH > > Hauptstraße 23a > A-7434 Bernstein > +43(664)38 06 107 > _______________________________________________ > Documentation mailing list > Documentation(a)lists.ipfire.org > http://lists.ipfire.org/mailman/listinfo/documentation > > > _______________________________________________ > Documentation mailing list > Documentation(a)lists.ipfire.org > http://lists.ipfire.org/mailman/listinfo/documentation > > > > -- > Ing. Karl SCHUH > > Hauptstraße 23a > A-7434 Bernstein > +43(664)38 06 107

2 2

Übersetzung
by SCHUH Karl, SCHUH-TV 05 Aug '13

05 Aug '13

Hi, I have seen Luke's mail and started the translation of http://wiki.ipfire.org/en/addons/wireless/start to german today. I will continue tomorrow and hope to finish it soon. Karl -- Ing. Karl SCHUH Hauptstraße 23a A-7434 Bernstein +43(664)38 06 107

3 6

Documentation workflow
by SCHUH Karl, SCHUH-TV 05 Aug '13

05 Aug '13

Hi, I have not watched the discussion very closely, so please apologize, if I say something, that has been cleared already. I agree, that everything should be documented in English first. But f or someone who wants to translate something, it is not easy to find a page, that is waiting. Maybe a table could help ? If something on an English-page is changed, the author and date of the change should be put in the table. If someone starts tto translate, he/she writes his name, the date and a status (maybe in %) on the same line. So everybody knows who did what and this person cpuld also be reached (for questions?). The translator also need information, if the page has been reviewed . Maybe this could be a note on the last line of the page? Regards, Karl -- Ing. Karl SCHUH Hauptstraße 23a A-7434 Bernstein +43(664)38 06 107

2 1

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

Documentation August 2013