Hello people,
I am busy with migrating the wiki to the new webapp.
For those who are not aware of this happening: We are going to move away from Dokuwiki. The story is quite a long one, but in short it is that I am unhappy with it. It has been a solid piece of software for us, but the user registration process is broken. People cannot sign up to it. Spam bots can. It does not look very nice and all in all it is written in PHP.
The original plan was to port our design to it, but actually it is easier just to write some wiki stuff into the web app where other parts already exist. So I decided to use our web app and add two things: An editor for the pages, a place to upload files and a big function that renders the pages. That is about it.
This wiki uses markdown. The syntax is very similar to the Dokuwiki syntax with exception of images, tables and some other smaller things. But markdown is widely used. Loads of people have probably used it somewhere else before. Also this is handy because I did not have to implement something that renders my own syntax.
I have been working on a unified account system which is coming along nicely. I have also been working on a converter that is porting all content from Dokuwiki to the new wiki. Unfortunately this is not the easiest thing.
The “new” wiki is currently available at https://wiki.dev.ipfire.org/.
Please feel free to browse around and have a look what works well and what doesn’t. All in all the converter converts a lot itself and I think the pages look nice and clean. But some things cannot be converted so there might be some stuff that we have to do manually.
The biggest of those are tables that do not follow the normal standard. The one on the index page for example is such a table.
The second thing that does not work very well is paths. Loads of links are broken and point at arbitrary stuff. The wiki now follows the usual filesystem approach with its URLs (: are / now) and you can go back with “..” and remain in the same directory with “.” or by using no prefix.
I also decided not to import the whole history of the wiki. I am not sure if there is any value in it. The data is old and there are tons of images that we no longer need. Also Dokuwiki has a nice API to go through all existing pages and going back into the archive is a bit more difficult.
So, please have a look around. Log in. Edit things. I will probably run the import again. Please help me find bugs and send me an email.
I would like to switch over as soon as possible.
Best, -Michael
Hi Michael,
I volunteer to help. One thing I could do is the work necessary to fix the broken links and helping with the manual operations to port the old documents to the new wiki.
Please let me know if there is anything else I can do to assist you.
— Carlo Fusco
On 23 May 2019, at 15:35, Michael Tremer michael.tremer@ipfire.org wrote:
Hello people,
I am busy with migrating the wiki to the new webapp.
For those who are not aware of this happening: We are going to move away from Dokuwiki. The story is quite a long one, but in short it is that I am unhappy with it. It has been a solid piece of software for us, but the user registration process is broken. People cannot sign up to it. Spam bots can. It does not look very nice and all in all it is written in PHP.
The original plan was to port our design to it, but actually it is easier just to write some wiki stuff into the web app where other parts already exist. So I decided to use our web app and add two things: An editor for the pages, a place to upload files and a big function that renders the pages. That is about it.
This wiki uses markdown. The syntax is very similar to the Dokuwiki syntax with exception of images, tables and some other smaller things. But markdown is widely used. Loads of people have probably used it somewhere else before. Also this is handy because I did not have to implement something that renders my own syntax.
I have been working on a unified account system which is coming along nicely. I have also been working on a converter that is porting all content from Dokuwiki to the new wiki. Unfortunately this is not the easiest thing.
The “new” wiki is currently available at https://wiki.dev.ipfire.org/.
Please feel free to browse around and have a look what works well and what doesn’t. All in all the converter converts a lot itself and I think the pages look nice and clean. But some things cannot be converted so there might be some stuff that we have to do manually.
The biggest of those are tables that do not follow the normal standard. The one on the index page for example is such a table.
The second thing that does not work very well is paths. Loads of links are broken and point at arbitrary stuff. The wiki now follows the usual filesystem approach with its URLs (: are / now) and you can go back with “..” and remain in the same directory with “.” or by using no prefix.
I also decided not to import the whole history of the wiki. I am not sure if there is any value in it. The data is old and there are tons of images that we no longer need. Also Dokuwiki has a nice API to go through all existing pages and going back into the archive is a bit more difficult.
So, please have a look around. Log in. Edit things. I will probably run the import again. Please help me find bugs and send me an email.
I would like to switch over as soon as possible.
Best, -Michael _______________________________________________ Documentation mailing list Documentation@lists.ipfire.org https://lists.ipfire.org/mailman/listinfo/documentation
— I will abandon this email address soon, You can reach me at carlo.fusco@pm.me
I tried to log in, but I get this error message:
------- Proxy Error
The proxy server received an invalid response from an upstream server. The proxy server could not handle the request POST /login.
Reason: Error reading from remote server -------
On 24 May 2019, at 12:58, Carlo Fusco fusco.carlo@gmail.com wrote:
Hi Michael,
I volunteer to help. One thing I could do is the work necessary to fix the broken links and helping with the manual operations to port the old documents to the new wiki.
Please let me know if there is anything else I can do to assist you.
— Carlo Fusco
On 23 May 2019, at 15:35, Michael Tremer michael.tremer@ipfire.org wrote:
Hello people,
I am busy with migrating the wiki to the new webapp.
For those who are not aware of this happening: We are going to move away from Dokuwiki. The story is quite a long one, but in short it is that I am unhappy with it. It has been a solid piece of software for us, but the user registration process is broken. People cannot sign up to it. Spam bots can. It does not look very nice and all in all it is written in PHP.
The original plan was to port our design to it, but actually it is easier just to write some wiki stuff into the web app where other parts already exist. So I decided to use our web app and add two things: An editor for the pages, a place to upload files and a big function that renders the pages. That is about it.
This wiki uses markdown. The syntax is very similar to the Dokuwiki syntax with exception of images, tables and some other smaller things. But markdown is widely used. Loads of people have probably used it somewhere else before. Also this is handy because I did not have to implement something that renders my own syntax.
I have been working on a unified account system which is coming along nicely. I have also been working on a converter that is porting all content from Dokuwiki to the new wiki. Unfortunately this is not the easiest thing.
The “new” wiki is currently available at https://wiki.dev.ipfire.org/.
Please feel free to browse around and have a look what works well and what doesn’t. All in all the converter converts a lot itself and I think the pages look nice and clean. But some things cannot be converted so there might be some stuff that we have to do manually.
The biggest of those are tables that do not follow the normal standard. The one on the index page for example is such a table.
The second thing that does not work very well is paths. Loads of links are broken and point at arbitrary stuff. The wiki now follows the usual filesystem approach with its URLs (: are / now) and you can go back with “..” and remain in the same directory with “.” or by using no prefix.
I also decided not to import the whole history of the wiki. I am not sure if there is any value in it. The data is old and there are tons of images that we no longer need. Also Dokuwiki has a nice API to go through all existing pages and going back into the archive is a bit more difficult.
So, please have a look around. Log in. Edit things. I will probably run the import again. Please help me find bugs and send me an email.
I would like to switch over as soon as possible.
Best, -Michael _______________________________________________ Documentation mailing list Documentation@lists.ipfire.org https://lists.ipfire.org/mailman/listinfo/documentation
— I will abandon this email address soon, You can reach me at carlo.fusco@pm.me
— I will abandon this email address soon, You can reach me at carlo.fusco@pm.me
Hello guys,
Thanks first of all to engage so much in this :)
On 24 May 2019, at 12:07, Carlo Fusco fusco.carlo@gmail.com wrote:
I tried to log in, but I get this error message:
Proxy Error
The proxy server received an invalid response from an upstream server. The proxy server could not handle the request POST /login.
Reason: Error reading from remote server ———
This seemed to be caused by a blacklist that we are checking to identify spammers. The blacklist did not seem to respond in time. I have removed that one now and I hope that this will now work better.
Best, -Michael
On 24 May 2019, at 12:58, Carlo Fusco fusco.carlo@gmail.com wrote:
Hi Michael,
I volunteer to help. One thing I could do is the work necessary to fix the broken links and helping with the manual operations to port the old documents to the new wiki.
Please let me know if there is anything else I can do to assist you.
— Carlo Fusco
On 23 May 2019, at 15:35, Michael Tremer michael.tremer@ipfire.org wrote:
Hello people,
I am busy with migrating the wiki to the new webapp.
For those who are not aware of this happening: We are going to move away from Dokuwiki. The story is quite a long one, but in short it is that I am unhappy with it. It has been a solid piece of software for us, but the user registration process is broken. People cannot sign up to it. Spam bots can. It does not look very nice and all in all it is written in PHP.
The original plan was to port our design to it, but actually it is easier just to write some wiki stuff into the web app where other parts already exist. So I decided to use our web app and add two things: An editor for the pages, a place to upload files and a big function that renders the pages. That is about it.
This wiki uses markdown. The syntax is very similar to the Dokuwiki syntax with exception of images, tables and some other smaller things. But markdown is widely used. Loads of people have probably used it somewhere else before. Also this is handy because I did not have to implement something that renders my own syntax.
I have been working on a unified account system which is coming along nicely. I have also been working on a converter that is porting all content from Dokuwiki to the new wiki. Unfortunately this is not the easiest thing.
The “new” wiki is currently available at https://wiki.dev.ipfire.org/.
Please feel free to browse around and have a look what works well and what doesn’t. All in all the converter converts a lot itself and I think the pages look nice and clean. But some things cannot be converted so there might be some stuff that we have to do manually.
The biggest of those are tables that do not follow the normal standard. The one on the index page for example is such a table.
The second thing that does not work very well is paths. Loads of links are broken and point at arbitrary stuff. The wiki now follows the usual filesystem approach with its URLs (: are / now) and you can go back with “..” and remain in the same directory with “.” or by using no prefix.
I also decided not to import the whole history of the wiki. I am not sure if there is any value in it. The data is old and there are tons of images that we no longer need. Also Dokuwiki has a nice API to go through all existing pages and going back into the archive is a bit more difficult.
So, please have a look around. Log in. Edit things. I will probably run the import again. Please help me find bugs and send me an email.
I would like to switch over as soon as possible.
Best, -Michael _______________________________________________ Documentation mailing list Documentation@lists.ipfire.org https://lists.ipfire.org/mailman/listinfo/documentation
— I will abandon this email address soon, You can reach me at carlo.fusco@pm.me
— I will abandon this email address soon, You can reach me at carlo.fusco@pm.me
Hi,
Login seems to be ok, but I'm missing some things that would make editing much easier:
- no 'preview' - no 'cancel' button ;-) - no toolbar with editing tools - no 'playground' for testing
Syntax should be no problem - I took a look at https://en.wikipedia.org/wiki/Markdown (is this the right language?).
I also found https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
There are a few examples here and there and this helps, but it would be great if we could get some kind of WUI for this in the future - an 'editor', as you wrote.
JM2C for now - Best, Matthias
Hi,
On 26 May 2019, at 09:28, Matthias Fischer matthias.fischer@ipfire.org wrote:
Hi,
Login seems to be ok, but I'm missing some things that would make editing much easier:
- no ‘preview'
Would you guys like that?
- no 'cancel' button ;-)
I thought you have a Back button :)
- no toolbar with editing tools
I looked for a nice JS tool, but they are all unmaintained for ages. So that has to be written from scratch.
- no 'playground' for testing
Just create the page :)
Syntax should be no problem - I took a look at https://en.wikipedia.org/wiki/Markdown (is this the right language?).
Yes, although we have some extensions. Wiki links work like they used to before.
I also found https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
There are a few examples here and there and this helps, but it would be great if we could get some kind of WUI for this in the future - an 'editor', as you wrote.
I will create a syntax reference as soon as we know that I do not have to re-import the whole thing.
Keep that in mind when you do any changes :)
-Michael
JM2C for now - Best, Matthias _______________________________________________ Documentation mailing list Documentation@lists.ipfire.org https://lists.ipfire.org/mailman/listinfo/documentation
Hi,
On 26 May 2019, at 09:28, Matthias Fischer matthias.fischer@ipfire.org wrote:
Hi,
Login seems to be ok, but I'm missing some things that would make editing much easier:
- no ‘preview'
Would you guys like that?
- no 'cancel' button ;-)
I thought you have a Back button :)
- no toolbar with editing tools
I looked for a nice JS tool, but they are all unmaintained for ages. So that has to be written from scratch.
- no 'playground' for testing
Just create the page :)
Syntax should be no problem - I took a look at https://en.wikipedia.org/wiki/Markdown (is this the right language?).
Yes, although we have some extensions. Wiki links work like they used to before.
I also found https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
There are a few examples here and there and this helps, but it would be great if we could get some kind of WUI for this in the future - an 'editor', as you wrote.
I will create a syntax reference as soon as we know that I do not have to re-import the whole thing.
Keep that in mind when you do any changes :)
-Michael
JM2C for now - Best, Matthias _______________________________________________ Documentation mailing list Documentation@lists.ipfire.org https://lists.ipfire.org/mailman/listinfo/documentation
Hi all, am currently not really in this topic but great Michael that you figuring something new out :-), thanks for that.
Wanted to ask if there is a possiblity for a language specific syntax highlighting like it was before via e.g. <code bash> code </code>
? Currently we have in the new wiki
``` code ``` was far as i could see in the first place...
Best,
Erik
Hi,
On 1 Jun 2019, at 13:09, ummeegge ummeegge@ipfire.org wrote:
Hi all, am currently not really in this topic but great Michael that you figuring something new out :-), thanks for that.
Wanted to ask if there is a possiblity for a language specific syntax highlighting like it was before via e.g.
<code bash> code </code>
? Currently we have in the new wiki
code
was far as i could see in the first place…
Yes, markdown supports that too. Just write:
```bash code ```
I did not test if our wiki highlights the syntax. If not, then the python module I am using does not support this or it isn’t switched on. In either case, let me know :)
-Michael
Best,
Erik
Documentation mailing list Documentation@lists.ipfire.org https://lists.ipfire.org/mailman/listinfo/documentation
Hello,
Sorry to pick this up this late again. It has been a month.
However, I removed all custom syntax from the wiki. We are now on pure Markdown and I did a reimport.
Please have a look as always.
I did not fix the syntax highlighting bug yet, but I will get to that soon.
Also I would like to push things out as soon as possible.
-Michael
On 6 Jun 2019, at 04:30, Jon Murphy jcmurphy26@gmail.com wrote:
Syntax highlights did not work for me. Maybe part of extended markdown.
code
I did not test if our wiki highlights the syntax. If not, then the python module I am using does not support this or it isn’t switched on. In either case, let me know :)
This might help with syntax highlighting:
https://fletcher.github.io/MultiMarkdown-6/syntax/fences.html https://fletcher.github.io/MultiMarkdown-6/syntax/fences.html
And multi markdown may help add other function enhancements (like tables, footnotes, etc).
https://fletcherpenney.net/multimarkdown/ https://fletcherpenney.net/multimarkdown/
From: Michael Tremer Sent: Tuesday, July 16, 2019, 11:34 AM To: Jon Murphy Cc: ummeegge; documentation@lists.ipfire.org Subject: Re: New Wiki Software - Please help testing :)
Hello,
Sorry to pick this up this late again. It has been a month.
However, I removed all custom syntax from the wiki. We are now on pure Markdown and I did a reimport.
Please have a look as always.
I did not fix the syntax highlighting bug yet, but I will get to that soon.
Also I would like to push things out as soon as possible.
-Michael
On 6 Jun 2019, at 04:30, Jon Murphy jcmurphy26@gmail.com wrote:
Syntax highlights did not work for me. Maybe part of extended markdown.
code
I did not test if our wiki highlights the syntax. If not, then the python module I am using does not support this or it isn’t switched on. In either case, let me know :)
Hi,
On 17 Jul 2019, at 04:17, Jon Murphy jcmurphy26@gmail.com wrote:
This might help with syntax highlighting:
https://fletcher.github.io/MultiMarkdown-6/syntax/fences.html
This was already on. There was just a python module missing as well as some CSS.
And multi markdown may help add other function enhancements (like tables, footnotes, etc).
This is however not a python module.
I changed from the markdown2 python module back to the default one which seems to be used more often. I think we should stick very closely to the original markdown syntax. I find that one quite loose already and it allows 10 different ways to do the same thing, but this is what people are used to.
On this test page I added some things. Images, tables. They seem to work and look fine.
https://wiki.dev.ipfire.org/test
Please test.
If there are no further objections, I would prefer to push out the new wiki next week.
Best, -Michael
From: Michael Tremer Sent: Tuesday, July 16, 2019, 11:34 AM To: Jon Murphy Cc: ummeegge; documentation@lists.ipfire.org Subject: Re: New Wiki Software - Please help testing :)
Hello,
Sorry to pick this up this late again. It has been a month.
However, I removed all custom syntax from the wiki. We are now on pure Markdown and I did a reimport.
Please have a look as always.
I did not fix the syntax highlighting bug yet, but I will get to that soon.
Also I would like to push things out as soon as possible.
-Michael
On 6 Jun 2019, at 04:30, Jon Murphy jcmurphy26@gmail.com wrote:
Syntax highlights did not work for me. Maybe part of extended markdown.
code
I did not test if our wiki highlights the syntax. If not, then the python module I am using does not support this or it isn’t switched on. In either case, let me know :)
Does this mean using only the Basic Syntax (John Gruber’s original design)? In my opinion, the basic syntax is not complete. I’d strongly suggest using the extended syntax (https://www.markdownguide.org/extended-syntax).
Will HTML be restricted? From Basic Syntax Markdown Guide (https://www.markdownguide.org/basic-syntax/):
Note: Using Markdown doesn't mean that you can't also use HTML. You can add HTML tags to any Markdown file. This is helpful if you prefer certain HTML tags to Markdown syntax. For example, some people find that it's easier to use HTML tags for images.
I changed from the markdown2 python module back to the default one which seems to be used more often. I think we should stick very closely to the original markdown syntax. I find that one quite loose already and it allows 10 different ways to do the same thing, but this is what people are used to.
Hi,
On 17 Jul 2019, at 23:57, Jon Murphy jcmurphy26@gmail.com wrote:
Does this mean using only the Basic Syntax (John Gruber’s original design)? In my opinion, the basic syntax is not complete. I’d strongly suggest using the extended syntax (https://www.markdownguide.org/extended-syntax).
No, this is the extended syntax that we are using here.
Will HTML be restricted? From Basic Syntax Markdown Guide (https://www.markdownguide.org/basic-syntax/):
No, not for now. But there is absolutely no point in using it.
Everything should be markdown. I will implement filtering HTML tags soon when there is time for it.
Note: Using Markdown doesn't mean that you can't also use HTML. You can add HTML tags to any Markdown file. This is helpful if you prefer certain HTML tags to Markdown syntax. For example, some people find that it's easier to use HTML tags for images.
Please don’t do that. What is the point of markdown in the first place then?
This will break the layout, make it impossible to render the documentation into PDF and many things more.
-Michael
I changed from the markdown2 python module back to the default one which seems to be used more often. I think we should stick very closely to the original markdown syntax. I find that one quite loose already and it allows 10 different ways to do the same thing, but this is what people are used to.
documentation@lists.ipfire.org