From mboxrd@z Thu Jan 1 00:00:00 1970 From: Michael Tremer To: documentation@lists.ipfire.org Subject: Re: New wiki painful to use Date: Tue, 27 Aug 2019 15:41:02 +0100 Message-ID: <26941CDF-7465-41DB-9E9B-52D16694939F@ipfire.org> In-Reply-To: <107641BE-C6B4-4B8C-A01A-26A86DC16059@gmail.com> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="===============7140111115236138039==" List-Id: --===============7140111115236138039== Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Hi, > On 15 Aug 2019, at 21:51, Jon Murphy wrote: >=20 >=20 >> I have asked for feedback and I got little. I do not think that many open = points were left that could have easily been implemented. This is why I wasn= =E2=80=99t too happy to read this email now, because I would have preferred s= ome constructive ideas and help over this now. >=20 >=20 > You are a tough person to send feedback to. You have a tendency to react i= n off-putting ways. Re-read your response. >=20 > You did receive my constructive ideas in the Documentation list. I told you why those are not possible to be implemented. >> First of all: There is no time to work on this. I have been doing nothing = else but infrastructure and admin work around the project for the last four w= eeks. I am barely able to respond to my email. One emergency after the other = is happening and I am doing =E2=80=9Cquick and dirty=E2=80=9D on more things = than I would like to. Bare this in mind. This is also the reason why I am a b= it on the edge. >=20 > How can I help? =20 >=20 > Since I=E2=80=99m not a firewall expert, I help with documentation (I start= ed working on the old wiki near April 2018) Writing documentation is very helpful. >=20 >=20 >=20 >> False information is worse than none. >=20 > Sorry to say but you=E2=80=99ll have to point those out (I know you are bus= y!). I=E2=80=99m not an expert but I have been going through and correcting = what I can. I don=E2=80=99t have the skills to identify false info.=20 Okay, I will put this on my list. >>From the top of my mind I know that we have some add-ons on the wiki that we = have dropped a long time ago. Some of those pages have a note that the featur= e has been dropped. I think there is no reason to keep those pages. >>> Did the https://github.com/benweet/stackedit.js not work? >>=20 >> This project hasn=E2=80=99t been updated in years. I am not going to integ= rate legacy software into something new. >=20 > Sorry for dwelling on this (and I=E2=80=99m not trying to make you mad): > To my unskilled eyes it looks like it was updated in Aug 2018. I saw your = concern about PageDown but there is not a Pagedown reference in the JS code. = On the webpage it states "stackedit.js is lightweight and has no dependency.= =E2=80=9D (I wrote a note to the developer to confirm). I am missing somethi= ng obvious=E2=80=A6 Stackedit.js is not an option at all. It just embeds an iframe and loads load= of stuff from the Internet. I do not want to send any user content to an untrusted third party. We also h= ave infrastructure documentation in this wiki and nobody needs to know this. = They even log for which page you are sending a request. Madness that it isn= =E2=80=99t even documented anywhere. So I wrote something lightweight and easy in less than 200 lines of JS code (= could be 50 lines without comments, etc.). It has the following features: * You can highlight text and then mark it as bold, italic, code or make a hea= dline or link out of it * You can use keyboard shortcuts which I find very neat, because you don=E2= =80=99t have to move your hands away from your keyboard. Hover over the icons= to see the shortcuts. Let me know if I forgot anything. There is also a link to the =E2=80=9Cfiles=E2=80=9D section now so that you c= an upload images with a few clicks only. I only tested this in Safari and FF. So there might be problems with other br= owsers. IE? No idea. Feedback is of course appreciated. >=20 >> I am also quite frustrated about seeing loads of HTML .... This is not how= this was intended and we have talked about why this is a bad idea. >=20 > What should I correct? The HTML I remember is: >=20 > Example to Example >=20 > I believe I wrote to you asking for guidance and did not receive a response. Please do not use *any* HTML. Please do not use any colours. They create barriers for people who cannot see= them. > Keep in mind, pages that look like this =E2=80=94> https://wiki.ipfire.org/= hardware/arm?revision=3D2019-08-06T13:57:34.868460 >=20 > Will now look like this =E2=80=94> https://wiki.ipfire.org/hardware/arm?rev= ision=3D2019-01-09T19:34:43 Yes, I am aware of that. The page can be organised in a different way so it d= oes not rely on those colours. > I=E2=80=99m sure you realize this is an uphill battle. Especially since us= ers are allowed/encouraged to update wiki pages. Without the code to limit o= r exclude HTML you=E2=80=99ll become the wiki cop and continue to be frustrat= ed by non-compliance. This doesn=E2=80=99t seem worth your time. I am not fighting any battles here. In case someone turns against our mission= that is a serious problem. We can have an argument, that is something totall= y different. Users are very much encouraged to update the wiki. I think it could not be ea= sier now. Nobody needs to have any skill apart from word. Writing some markup syntax is in the nature of a wiki (see Wikipedia) and it = works. >> I am also quite frustrated about ... only the word =E2=80=9Cupdate=E2=80= =9D in the change log. >=20 > Look at the revisions for a single page. You see many proper remarks. The= =E2=80=9CUpdate=E2=80=9D is normally a quick change where I got frustrated f= ighting the interface to get a page completed. My bad. I will do better. No need to write a novel here. Three words can be enough. It just should be c= lear that the page has not only changed but what (and maybe why if it isn=E2= =80=99t just some syntax stuff). > Again, none of this is meant to be mean. It just my feedback. I didn=E2=80=99t take it like that. Please keep it coming. Best, -Michael --===============7140111115236138039==--