Documentation

documentation@lists.ipfire.org

226 discussions

This list is now closed
by Michael Tremer 01 Jun '21

01 Jun '21

Hello everyone, I want to thank you all for participating here. Since this list is practically unused, and we already have a space on the community portal for this, I am going to close it. Please join over here: https://community.ipfire.org/c/community/documentation/24 Best, -Michael

1 0

Wiki - doku
by tulpenknicker＠disroot.org 30 May '21

30 May '21

I have the urgent need to address the following things that are currently bothering me. The current development of the wiki does not give me much pleasure. I have already been in contact with the author about this. I'm especially concerned about what I see as an extremely wrong balance between having enough pictures and information to understand, but not being recognized as a picture book or "idiot guide" on the other hand. Furthermore there is a discrepancy of understanding. Either I am totally wrong or the author is. Whereby I would like the latter more ;-) It is about the definition DMZ Pinhole. My understanding is that this is used regardless of whether orange is involved or not, i.e. if you want to get from one isolated, separate network to the next, that's a DMZ pinhole for me. For the author it is a blue green pinhole. Therefore he created/changed the pages https://wiki.ipfire.org/configuration/firewall/default-policy https://wiki.ipfire.org/configuration/firewall/accesstoblue And created a "picture book". The only thing that is "missing" is the marking of which key to press... https://wiki.ipfire.org/configuration/firewall/rules/bg-holes Urgent clarification is requested on my part. As it looks to me the author only promotes a new generation of copy and paste professionals. It seems to me that he has only considered that he wants to help everyone. What this can cause is not considered. The style how the whole was formulated rounds it then down. It reminds me somehow a small child to motivate and to hold out to the end. We're almost there...just this...hang in there.... I may be too dogged about the latter. Probably I'm just too old ;-) What annoys me most about the whole story is the fact that this informations are many years written and has already been changed several times. So already many have looked over the Doku. Regardless of whether one is now right with something or not, if someone brings forward an objection then at least for me the absolute logical consequence is that this must be discussed! Until its resolved! If necessary you ask someone else to join the party to provide who has there now right. To change it anyway with the words ~ "I have not understood that way, that has nothing to do with it for me" does not make it automatically right for all others. This train of thought is totally alien to me and also completely unacceptable! It is important to me that the whole thing is not understood as pure criticism. My only interest is whether the wiki is correct and meaningful or false and unnecessary. The only reason why I post it here publicly is because there was no progress in the conversation between 4 eyes. And someone from the IPF Team i asked before this step, gave me the advice to ask here.

4 6

Making things clearer - writing for dummies
by Michael Tremer 05 May '20

05 May '20

Good morning, I spent some time today to edit the wiki. We had a rather longish discussion at our monthly telephone conference call about the state of the Community Portal and that we are all rather frustrated about what is going on there. We fell that people do not read the wiki. That could have multiple reasons: Either they do not know the wiki exists. People could not find what they are looking for - or they simply did not care to read anything and let other people do their work for them. Not reading the wiki results in plenty of questions that have been answered a hundred times or simply should not be asked by a person who is running a firewall. The latter is a really big concern, because we have people managing business networks who are unable to SSH into their firewall. That is a security disaster waiting to blow up. Since we have all limited time to reply to people - and patience in my case - I would like to propose to make some changes: I do NOT want to pick up people from where they are any more. If people cannot install PuTTY then there is plenty of places that explain very well on how to double-click an EXE file. We have to ask for a minimum level of skill. Otherwise the wiki becomes very verbose and reading a guide about something that takes five clicks spends the first two pages on how to install required software. But what I would like to do is making things shorter. Short pages are good. They are easy to read - even when someone is only reading headlines. They are easy to link to and people will find what is interesting instead of searching through too much text and image. For example: The start page is shorter (https://wiki.ipfire.org). Links were hidden in text and they are now a simple bullet point list. I would also like to make things clearer. Very often, I have written things where in the end, the reader has to evaluate what is right for them. That clearly does not work. People are making poor decisions and do not understand why. Those are horrible support cases which will never make anyone happy. As an example (https://wiki.ipfire.org/hardware/virtual): I have almost entirely removed the pages about virtualisation. There is no reason why we should give people arguments about why to do this. We should advocate the opposite and that is what a new short page does. It has information about on what hypervisors IPFire runs, but clearly states that that is a bad idea for multiple reasons. People who really want to do this hopefully know why and what the potential problems are. I would like to hear some feedback from the regular editors of the wiki if these things make sense. Maybe we should write some kind of policy at some point so summarise all these things for future editors. Do you have any concerns why people might be unsuccessful with the wiki? Best, -Michael

1 0

BackUP-PC wiki
by ummeegge 17 Nov '19

17 Nov '19

Hi all, just wanted to point out that the Back-PC wiki https://wiki.ipfire.org/addons/backuppc is meanwhile very old, a linked binary in there for full functionality is not available anymore, ... . Does it makes sense to keep this wiki ? Best, Erik

2 1

Re: Trashed wiki pages
by Michael Tremer 10 Oct '19

10 Oct '19

Hi, I saw this as well. I am not sure if it is intentional or not. Definitely not great. I have added a restore feature to the wiki, so that going back to the latest correct version of the page is one click now. You will see a small icon on the revisions list and can do it as well. I have rolled out more changes to the wiki right now and will send you guys an extra email. Best, -Michael P.S. I have restored all pages that this user has messed up > On 9 Oct 2019, at 18:01, Jon Murphy <jcmurphy26(a)gmail.com> wrote: > > Also, the breadcrumbs are missing from many pages. I’m note sure if this was caused after the mess or something else. > > If this belongs in BZ, please let me know and I will add. > > > Jon > >> From: Jon Murphy >> Sent: Wednesday, October 9, 2019, 11:52 AM >> To: Michael Tremer >> Subject: Trashed wiki pages >> >> >> Michael - there is a user named Ryan Paolello that made a mess of a few wiki pages. I am not sure if this is someone lacking experience (unlikely) or someone intentionally messing thing up. >> >> >> https://wiki.ipfire.org/wiki was https://wiki.ipfire.org/wiki?revision=2019-07-30T15:46:52.669434 >> >> >> https://wiki.ipfire.org/configuration/login was https://wiki.ipfire.org/configuration/login?revision=2018-09-02T22:50:31 >> >> >> >> Jon >> >> >> <Screen Shot 2019-10-09 at 11.44.12 AM.png> >

1 0

Re: Re: Browser based editor for markdown
by Jon Murphy 06 Oct '19

06 Oct '19

Another browser based edit. (Not sure if this meets the requirements) https://markdown-it.github.io <https://markdown-it.github.io/> https://github.com/markdown-it/markdown-it <https://github.com/markdown-it/markdown-it>

1 0

How to delete images?
by Jon Murphy 24 Sep '19

24 Sep '19

I’ve been working on some wiki pages for OpenVPN iOS and I made a big mess! How do I delete images? I saw there is an "?action=detail" at the end of a URL. Is something like an "?action=delete" available?

2 1

New wiki painful to use
by Jon Murphy 06 Sep '19

06 Sep '19

In my opinion: I feel you’re going to see a drop-off of user written wiki pages. The new wiki is very painful to use! (I do understand there are not many users writing wiki pages.) Most of this is related to the lack of a user interface with built-in shortcuts for bold, italics, links, code blocks, etc. The wiki really needs a proper user interface like what was available with the old wiki or what is available with the forum. Is there not another wiki to fit the need? Like a competitor to Dokuwiki? I’d hate to think the IPFire firewall devs would need to be spending their time creating a new wiki. Did the https://github.com/benweet/stackedit.js <https://github.com/benweet/stackedit.js> not work? Nothing written above is meant to hurt anyone’s feelings or make anyone mad. I’m just personally frustrated working in the new wiki environment knowing I’ve only touched 80 pages and we have 300+ pages to go! Ugh! Jon

4 12

Is nonpublic still Active?
by Jon Murphy 03 Sep '19

03 Sep '19

Michael - There are lots of wiki pages in the 'nonpublic' path (wiki.ipfire.org/nonpublic). What is nonpublic and is it still active or needed?

2 1

Delete Testday web pages?
by Jon Murphy 30 Aug '19

30 Aug '19

Michael - there are a few pages related to ‘testday'. I am guessing they are from Y2014. https://wiki.ipfire.org/configuration/firewall/testday Can they be deleted?

2 1

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

Documentation