Re: [LEDE-DEV] Lede/Openwrt documentation

2017-12-08 Thread Ben Mulvihill
May I make a late contribution to this thread? As a user and occasional contributor to openwrt and lede I'd like to stress how invaluable the openwrt wiki in its current form is, precisely because it is real hotchpotch. Of course it is unstructured, of course there is redundancy, of course some of

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-16 Thread Alberto Bursi
On 16/11/2017 21:42, Javier Domingo Cansino wrote: Before this thread falls into oblivion, I would like to ask the guys on charge of the docs (I think I got the correct emails) for feedback. The general impression from the list that I have is that there are a lot of doubts on if such a hardcor

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-16 Thread Javier Domingo Cansino
Before this thread falls into oblivion, I would like to ask the guys on charge of the docs (I think I got the correct emails) for feedback. The general impression from the list that I have is that there are a lot of doubts on if such a hardcore change in documentation will work, but the benefits s

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-13 Thread Alberto Bursi
On 13/11/2017 13:11, Jo-Philipp Wich wrote: Hi, The wiki is working for me. it's great to have the ToH. Also the device pages are great. However the wiki is not always completely correct and may be just wrong. It's a wiki, change it! A wiki is always changing. I believe that a wiki is no alt

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-13 Thread Jo-Philipp Wich
Hi, > The wiki is working for me. it's great to have the ToH. Also the > device pages are great. However the wiki is not always completely > correct and may be just wrong. It's a wiki, change it! A wiki is > always changing. I believe that a wiki is no alternative for a proper, curated documentat

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-12 Thread Javier Domingo Cansino
> But it seems like a) way more hassle than editing a wiki directly and > b) requires a github account. The github account is the same as the wiki account, but I do agree that is more hassle mainly because it's not an integrated experience > I do some stuff with github, but so fa

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-12 Thread Sebastian Moeller
Hi Javiet, > On Nov 12, 2017, at 22:24, Javier Domingo Cansino wrote: > >> Editing the page happens through Github's web editor and web interface, >> both are utter garbage for code, and even more so for text-based >> documentation. Plus the whole fact that you are required to open a PR, >> whi

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-12 Thread Javier Domingo Cansino
> Editing the page happens through Github's web editor and web interface, > both are utter garbage for code, and even more so for text-based > documentation. Plus the whole fact that you are required to open a PR, > which is a completely alien concept for non-developers. If someone has an small ch

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-12 Thread Sebastian Moeller
Dear Javier, first of, I am just a very casual contributor; only added a few details to the sqm user guide, so I do not assume my word having much weight. Well, just from my perspective, if I had to create PRs for my changes and additions to the sqm user guide, I certainly would not have made o

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-12 Thread Alberto Bursi
On 11/11/2017 01:40 AM, Javier Domingo Cansino wrote: Hello, I have continued working on the docs https://lede.rtfd.io. It now contains a Proof of Concept, with the following features: * Documentation can be exported in different formats, html (hosted in https://lede.rtfd.io), single page htm

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-12 Thread Javier Domingo Cansino
> The wiki is working for me. it's great to have the ToH. Also the device pages > are great. However the wiki is not always completely correct and may be just > wrong. It's a wiki, change it! A wiki is always changing. Just in case, we are not loosing the ToH, it's just that I didn't implement i

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-12 Thread Paul Oranje
M2C: Wiki's are wonderful for documentation purposes as it allows anyone to attribute without much difficulty. But how to ensure that the documentation follows project code changes ? Add to https://lede-project.org/submitting-patches the instruction that any change that would have consequences

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-11 Thread Alexander Couzens
Here is my IMHO: wiki = OpenWrt and LEDE The wiki is working for me. it's great to have the ToH. Also the device pages are great. However the wiki is not always completely correct and may be just wrong. It's a wiki, change it! A wiki is always changing. But I still see the case, where I would li

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-10 Thread Javier Domingo Cansino
Hello, I have continued working on the docs https://lede.rtfd.io. It now contains a Proof of Concept, with the following features: * Documentation can be exported in different formats, html (hosted in https://lede.rtfd.io), single page html, pdf, ebook etc. * Documentation has been edited in a si

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-07 Thread Javier Domingo Cansino
Hello, I haven't been able to open a computer past week, so this is running slower than I thought. I have made it available in https://lede.readthedocs.io/en/latest/ and for now it's just the start + about page. I will keep adding pages until I cover the basics, and send an email when it's more r

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-30 Thread Javier Domingo Cansino
> To clarify: the "convert dokuwiki to git" thing I was talking about is > just a technical possibility for merging the OpenWrt wiki and the LEDE > wiki. I was certainly not suggesting to switch to a completely new system > for the wiki: I think it's fine as it is for most of the documentation.

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Baptiste Jonglez
Hi, On 27-10-17, Javier Domingo Cansino wrote: > > This problem is well-known [1,2] and can be solved by having access to a > > common ancestor between the two versions. A possible way to do this would > > be to convert each wiki to a git repository [3], merge the two histories > > using git, and

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Baptiste Jonglez
Hi Alberto, On 27-10-17, John Norton wrote: > On 27/10/2017 10:46, Baptiste Jonglez wrote: > >On 24-10-17, John Norton wrote: > >>On 24/10/2017 18:02, Javier Domingo Cansino wrote: > >>Imho (what I would do) is just migrate current LEDE wiki content in OpenWRT > >>wiki, > >>while current OpenWRT s

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Thomas Endt
> It seems that there was a bit of confusion. What you quote here is > from me, not from Javier. Also, it's from a different thread [1], in > which I indeed proposed a new system from the developer documentation > (only). > > The current thread is about how to merge the LEDE wiki and the OpenWrt

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Baptiste Jonglez
Hi Thomas, On 27-10-17, Thomas Endt wrote: > That's contrary to your statements in the start posting: > > > [...] documentation targeted at hackers, contributors, and would-be > > developers. > > [...] RFC proposal of a new developer documentation > > Links [1] [2] [3] > > [...] more focused sco

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Thomas Endt
> > - We are talking about the developer pages only, or about the > complete > > content? > > Everything That's contrary to your statements in the start posting: > [...] documentation targeted at hackers, contributors, and would-be > developers. > [...] RFC proposal of a new developer documenta

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Thomas Endt
> > The wiki currently hosts and renders tables on the basis of data > > acquired and stored in a database. > > The table of packages and table of hardware. They are searchable and > > can be filtered. > > The table of hardware has a template system to let people add new > > devices to the "hardwar

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Javier Domingo Cansino
> Just to get a clear picture: > - We are talking about the LEDE wiki pages or the OpenWrt wiki pages, or > both? http://lists.infradead.org/pipermail/lede-dev/2017-October/009564.html > - We are talking about the developer pages only, or about the complete > content? Everything -- Javier Domi

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Javier Domingo Cansino
> If you want to use the GH editor, I'd go with markdown. For markdown, > the GH web editor has syntax highlighting and and (more important) a > usable preview mode, for RST all you get is a very simple plain text editor. I think you are right, we can do markdown for now and later change some pag

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Thomas Endt
> > What exactly do you need? All wiki pages? Including history? > > Will look into this this evening. We will find an easy way. > > Someone mentioned there were private pages, but if possible, I would > create a git repo, commit all the content and upload it to github. I > can work on a proper hi

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Richard Kunze
Hello everybody, here my 2 cents: > This system would work through PRs in github, and the user could link > "Edit this file in github", which would direct him to the file, and > there he would be able to click on "Fork and edit", and then submit a > pull request. From my experience, this works

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Javier Domingo Cansino
I will suppose all the proposals are accepted when answering > I see this can be a good way forward, but I have some questions. > > I still think user-level documentation must have a decent wiki-like editor > in the browser, because github's editor > sucks big way, and isn't suited for proper form

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread tmo
Am 27. Oktober 2017 15:14:19 MESZ schrieb Javier Domingo Cansino : >> And yes, I'm talking of things I can/will do personally. > >Is there any way to access all the wiki files? I am doing it manually >and its turning out to be quite tedious... =) What exactly do you need? All wiki pages? Includin

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Alberto Bursi
On 27/10/2017 15:14, Javier Domingo Cansino wrote: And yes, I'm talking of things I can/will do personally. Is there any way to access all the wiki files? I am doing it manually and its turning out to be quite tedious... =) afaik the only way is accessing the server itself over ssh. There al

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread John Norton
On 27/10/2017 13:58, Javier Domingo Cansino wrote: This problem is well-known [1,2] and can be solved by having access to a common ancestor between the two versions. A possible way to do this would be to convert each wiki to a git repository [3], merge the two histories using git, and then con

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Javier Domingo Cansino
> And yes, I'm talking of things I can/will do personally. Is there any way to access all the wiki files? I am doing it manually and its turning out to be quite tedious... =) -- Javier Domingo Cansino ___ Lede-dev mailing list Lede-dev@lists.infradead

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread John Norton
On 27/10/2017 10:46, Baptiste Jonglez wrote: Hi, On 24-10-17, John Norton wrote: On 24/10/2017 18:02, Javier Domingo Cansino wrote: Imho (what I would do) is just migrate current LEDE wiki content in OpenWRT wiki, while current OpenWRT stuff is either obsoleted (where it is replaced by the LE

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Javier Domingo Cansino
> This problem is well-known [1,2] and can be solved by having access to a > common ancestor between the two versions. A possible way to do this would > be to convert each wiki to a git repository [3], merge the two histories > using git, and then convert back the git repository to a dokuwiki > st

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Baptiste Jonglez
Hi, On 24-10-17, John Norton wrote: > On 24/10/2017 18:02, Javier Domingo Cansino wrote: > Imho (what I would do) is just migrate current LEDE wiki content in OpenWRT > wiki, > while current OpenWRT stuff is either obsoleted (where it is replaced by the > LEDE wiki articles) or moved to suit the s

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-24 Thread Javier Domingo Cansino
> Depends on the direction we will be moving, see above. If I can give my opinion, having little training on openwrt-lede code base specifics, I find the LEDE docs better organized. My contributions were around 2 years ago, and focused on documenting the libs that are used in the core of lede-ope

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-24 Thread Thomas Endt
> -Ursprüngliche Nachricht- > Von: Lede-dev [mailto:lede-dev-boun...@lists.infradead.org] Im Auftrag > von John Norton > Gesendet: Dienstag, 24. Oktober 2017 18:20 > An: lede-dev@lists.infradead.org > Betreff: Re: [LEDE-DEV] Lede/Openwrt documentation > > > &g

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-24 Thread John Norton
On 24/10/2017 18:02, Javier Domingo Cansino wrote: Hello, I have been reviewing email on the archive about what will happen with openwrt/lede documentation on the remerge, and I couldn't reach any conclusion. Would mind anyone clarifying? Cheers, Javier _

[LEDE-DEV] Lede/Openwrt documentation

2017-10-24 Thread Javier Domingo Cansino
Hello, I have been reviewing email on the archive about what will happen with openwrt/lede documentation on the remerge, and I couldn't reach any conclusion. Would mind anyone clarifying? Cheers, Javier ___ Lede-dev mailing list Lede-dev@lists.infrade