LEDE / OpenWrt wiki merge

I also carried over https://openwrt.org/meta/translation, just as a starting point.
It's clear that this needs to be adapted to the new OpenWrt wiki.

The issue is that they look the same but in actual fact the first link will
redirect the user to the the opener wiki. Which in my case was a dated
page without the LEDE new builds. The latter link has the LEDE builds but
is not the page references from it's own main site https://lede-project.org.

I appreciate the efforts from you and the team with the process of the
merger and would like to help where I can with fixing thsse wiki gaps as
soon as possible to prevent user problems and frustration.

you are missing "already voted on"

you may not like the decisions that are made, but there will be people who
dislike any decision, but that doesn't mean that you can endlessly debate every
decision. At some point work needs to be done.

Get the content merged and then propose a new look and feel to the content.

David Lang

I've mostly merged the two wikis layout, yay!
Now all articles are more or less sorted and the user guide content is navigable, in a structure that resembles the LEDE wiki, to some extent.
See https://openwrt.org/docs/start and https://openwrt.org/docs/guide-user/start

Now I think casual contributors can greatly help by doing some of the following:

  • change the names of the articles (with the "rename page" button on the right, not changing the title) to make sure that the page name has the correct keywords for the search system to find them.

  • give good descriptive names to all articles

  • check articles in the same category and merge duplicates or redundant information, dump legacy useless information. (this should be done by people that have some experience in the topic discussed in the article, if you are not sure, don't delete stuff please)

  • edit articles to conform more to the wiki contribution guide https://openwrt.org/wiki/wikirules

  • do the same layout treatment to the development guide/documentation as I didn't do much on it because of time constraints.

@jow I've made a UCI networking table cheatsheet here https://openwrt.org/docs/guide-user/network/ucicheatsheet is it OK? does it need all networking UCI options? All UCI options? Using the system suggested by tmomas the table is just pulling the tables from articles, so any edit to the articles will be shown in the table as well

Yay! :slight_smile:
Thanks for the hours of work you put into this!

Not sure if it is a good idea to let casual users do this task. IMO this should be done by us, the documentation team.

A casual user might have a very narrow sight: "This one page must be renamed."
We should have a broader view of the wiki and be looking for systematical naming of the pages.
In addition to this, the wiki admins have access to a statistics plugin which shows a statistic of the searchwords entered into the wiki search: Admin -> Searchword statistic

Yes, it's crude. It lists words, not phrases, splitting "Archer C7" in "Archer" and "C7", making it a bit difficult to interpret what the user has been searching for. However, it gives slight hints to what users are searching for.
Search optimization is a whole topic for itself (and we should probably create a separate new topic for this).

...good names and titles.

I often ask myself, what was page name and what was page title again?
page name = the filename, e.g. docs/guide-developer/adding_new_device
page title = the thing in bold and big fontsize at the top of the page; in wikisource: "====== Adding a new device ======"

Nice example for section includes!

Two more broken links found a few minutes ago...

I did run batch-rewriting for a ton of links (mostly about where to find firmware, where is the build system, and other such things) but I haven't finished. I started with the broken links that were present in most pages.

If some links are more important for you, please list them here so I fix them first.

I'm referring to older links that are not being re-directed to the newer links.

https://openwrt.org/meta/create_new_device_page not work.

Is available any device page template creator?

I'm also trying to create a missing device page. I can edit pages, but I don't see a "create this page" button when I navigate to the missing device page...

I'm currently cleaniing up a bit and need your help.
What would be the replacement for the following links?

doc:uci:network#interfaces
doc:uci:network#ipv4.routes
doc:uci:network#ipv6.routes
doc:uci:network#protocol.dhcp
doc:uci:network#protocol.static
doc:uci:network#protocol_l2tp_ppp_over_l2tp_pseudowire_tunnel
doc:uci:network#static.ipv6-in-ipv4.tunnel
doc:uci:network#protocol_6in4_ipv6-in-ipv4_tunnel
doc:uci:network#protocol_qmi_usb_modems_using_qmi_protocol
doc:uci:network#protocol.pptp.point-to-point.tunneling.protocol

Thanks. :grinning:

They were links pointing to subsections of this page in the old wiki (yes you already know this, it's mostly for making sure that everyone reading this is on the same page as we are and can fact-check what I post) https://wiki.openwrt.org/doc/uci/network

I've mostly just split or moved them in articles talking of their own topic, The following are 100% the same stuff and can be replaced as-is.

doc:uci:network#interfaces >>> https://openwrt.org/docs/guide-user/base-system/basic-networking#interfaces

doc:uci:network#ipv4.routes >>>> https://openwrt.org/docs/guide-user/network/routes_configuration#ipv4_routes

doc:uci:network#ipv6.routes >>>> https://openwrt.org/docs/guide-user/network/routes_configuration#ipv6_routes

doc:uci:network#protocol_l2tp_ppp_over_l2tp_pseudowire_tunnel >>>> https://openwrt.org/docs/guide-user/network/ipv6_ipv4_transitioning#protocol_l2tp_ppp_over_l2tp_tunnel

doc:uci:network#static.ipv6-in-ipv4.tunnel >>> https://openwrt.org/docs/guide-user/network/tunneling_interface_protocols#static_ipv6-in-ipv4_tunnel

doc:uci:network#protocol_6in4_ipv6-in-ipv4_tunnel >>> https://openwrt.org/docs/guide-user/network/ipv6_ipv4_transitioning#protocol_6to4_ipv6-in-ipv4_tunnel

doc:uci:network#protocol_qmi_usb_modems_using_qmi_protocol >>> https://openwrt.org/docs/guide-user/network/wan/wwan/ltedongle#qmi_protocol_configuration

doc:uci:network#protocol.pptp.point-to-point.tunneling.protocol >>>> https://openwrt.org/docs/guide-user/network/tunneling_interface_protocols#protocol_pptp_point-to-point_tunneling_protocol


These last two actually map to 2 different articles, one for IPv4 and one for IPv6 where I split the configuration options (dhcp in ipv6 always had a different protocol anyway) to reduce confusion about what setting is for ipv4 and what is for ipv6.

I suggest to replace that with a link to a page where the user can then decide if he wants the info about his topic for IPv4 or IPv6, and from there click on the link that brings him to the final destination article.

doc:uci:network#protocol.dhcp >>> both https://openwrt.org/docs/guide-user/network/ipv4/start#protocol_dhcp and https://openwrt.org/docs/guide-user/network/ipv6/start#protocol_dhcpv6

doc:uci:network#protocol.static >>> both https://openwrt.org/docs/guide-user/network/ipv4/start#protocol_static_ipv4 and https://openwrt.org/docs/guide-user/network/ipv6/start#protocol_static_with_ipv6

1 Like

Where shall we put the new pages and how shall we name them?

Proposals:


https://openwrt.org/docs/guide-user/network/dhcp
Alternative:

DHCP configuration for IPv4 / IPv6 is different. Please chose which one you want to configure.

-> [Link to IPv4 DHCP config]
-> [Link to IPv6 DHCP config]


https://openwrt.org/docs/guide-user/network/static
Alternative:

Static configuration for IPv4 / IPv6 is different. Please chose which one you want to configure.

-> [Link to IPv4 static config]
-> [Link to IPv6 static config]


ok for the alternative links and the article contents.

@bobafetthotmail
I would like add Domoticz to https://openwrt.org/docs/guide-user/services/automation/start?do=index
I don't have rights ? How to do it ? I can click "Edit" but don't see option do add new page

you can create the new page by writing the link to it and then editing the page.

For example this is a link to a page called "domoticz" https://openwrt.org/docs/guide-user/services/automation/domoticz
Which does not exist yet. Click on the pencil button on the right to edit/create it.

You can edit the link however you like and it will land in the same "there is no page yet" page and you will be able to create a page there. https://openwrt.org/docs/guide-user/services/automation/domoticz_another_page

The page made with that link will then appear automatically in the "automation" category in other pages that show it, like here https://openwrt.org/docs/guide-user/services/automation/start

@tmomas is there a better way to create a new page in a specific place? Do we have something like "create a new page" page/template/thing that is a bit more intuitive and user-friendly than manually editing the URL in the browser?

IIRC there are some solutions for easier creation of new pages.

  • catlist has index functions like pagequery but also has a button for page creation
  • addnewpage has only easy page creation function

Examples: https://openwrt.org/playground/docs/guide-user/services/automation/start

1 Like

Thanks a lot. I just create the page and will update it.

Interesting. I like catlist more, see the mockup I made in the same wiki page, that's what I would like to replace the user guide page with (and replicate around the wiki, replacing the current usage of the other pagequery plugin).

I would only like to increase a bit the text size, especially for the text when creating a new page which is tiny.
At least the links are already larger than the current pagequery plugin we are using, so it's better even as-is.

Should be doable via CSS.

Doesn't matter now, but fontsize of pagequery can be adjusted via the "fontsize" option.