Creating Device Pages in LEDE Wiki

Testing, 1, 2, 3...

I'm replying via email to see how it the inserted comments appear in the forum (as opposed to clicking the Visit Topic button). You can ignore this note, since I already made substantive comments in the forum.

Subject line is: "Re: [LEDE Project Forum] [LEDE Wiki] Creating Device Pages in LEDE Wiki"

I've put <inserted comment #1>, <inserted comment #2> into the message...

PLEASE IGNORE THIS NOTE!

Oh, cool... Only my top-posted text appears in this response. No comments inserted into the body of are there (since the forum seems to omit the previous info...)

There is now:
folded plugin https://www.dokuwiki.org/plugin:folded <--- disabled again; unsure if this is the reason for the double dataentries
outliner plugin https://www.dokuwiki.org/plugin:outliner

Please check them out and let me know which one is the prefered one.

Sidenote: Nested quoting seems to be a problem for this forum, at least for the "mark & click reply" method.

Oh, look at what we have here, templating things wasn't a so original idea after all. please read my post here:here

tl:dr: basically turn all most usual flashing instructions in templates and load them automatically in device pages with device/brand-specific tweaks the same as you do with other things proposed here.

I have a very dim view of tags, I'd rather not see them around.

Tag systems tend to fill up with total nonsense tags and are another layer of mainteneance required for very little gain. Because really, why tags in a wiki, we have links, text search. Tags kinda make sense for image-based sites where you need to categorize images, but here... nope.

I'd say to disable them for good.

OK. All three of us agree - No to tags. Whew, one decision down, several hundred to go :slight_smile:

Tag plugin disabled.

I'll also mention it in this topic... See my prototype (draft, nowhere near final) template for a Device Page at: https://wiki.lede-project.org/playground/sample-device-page

It's fun to think about whether we could automatically populate the page in its entirety by excerpting info from the ToH and the dataentry's...

I forged ahead and created a real LEDE device page for the D-Link DIR 860L, based on

  • layout suggestions of this discussion thread
  • real data from the legacy OpenWrt side of 860L
  • some stuff I've added

-> https://lede-project.org/toh/d-link/dir-860l

missing:

  • haven't migrated OpenWrt Photos yet
  • tags missing (I think there is no tag plugin activated so far? https://www.dokuwiki.org/plugin:tag)
  • dmesg output from a release version is missing (I am currently running a snapshot and think, adding snapshot firmware output to a device page is not a good idea)

As for now, I'd appreciate to not create any devicepages in the LEDE wiki.
OpenWrt and LEDE wiki will be merged anyways, once the merge of both projects is official and the necessary prerequisites are fulfilled.

Having the devicepages separated in the Openwrt wiki will allow for an easier merge.
While we are merging, we should also restucture the pages, because they are a wild mix of styles, contain outdated information and are just in bad shape. But that will be a separate (long) discussion.

it's ok. have removed it in the mean time, kept a backup.

Tag plugin re-enabled again due to import of OpenWrt devicepages, which are using tags.

I'm not sure if this is the right spot, but the auto-generated pages were a bit confusing in that "old" versions appeared first. "What, discontinued???? I saw an Archer C7 on Amazon last month!" -- Well, it was v2 that was discontinued, and v4 is buried down the page quite a ways. Sorting the version sections in reverse-chronological order, and adding a section title to make it easier to wade through the mass of tables they produce, would improve usability, in my opinion.

https://openwrt.org/toh/tp-link/archer-c7-1750#info

I find the ToH firmware list easier to follow...

https://openwrt.org/toh/views/toh_fwdownload?dataflt[Model*~]=archer+c7

I now added sorting by version.

I updated the Archer C7 page to use a new template_hardwaredetailsheader that puts a header containing the vendor/model/version above each of the two-column hardware details.

https://openwrt.org/meta/template_hardwaredetailsheader

Perhaps this could update the current https://openwrt.org/meta/template_datatemplatelist

NB I couldn't find a way to make that header "stick" to the columns below it, but I think this is pretty clear.

Update: I was able to enclose both columns of data within the header's table, so this looks OK now

With an ugly side-effect: Place your mouse on the table and see what happens... :frowning:

Yes. I reverted it.

[updated] Also on the Archer C7 page, I noticed several things in the "Installation" table:

  1. There were no URLs in the OpenWrt firmware columns. I changed the underlying datatable cols: definition by changing "Firmware Openwrt..." to "Firmware LEDE..." and the URLs showed up
    I don't know how to fix this globally - where is it most effective to change the definitions?

  2. I think the previous column headers were confusing. I changed them to:

  • OpenWrt Factory Firmware
  • OpenWrt Sysupgrade Firmware
  • OEM Stock Firmware
    I would like to use the same terminology in the Device Page as the flashing instructions, etc. to avoid confusion newcomers who are struggling to understand the various flavors.

The dataentries.
Still on my to do list, but I think I can manage the update during the weekend.

See also: https://openwrt.org/wiki/maintenance/to_do_list#dataentries

Regarding headers: They can be chosen as we wish.
How are we refering to them in everydays communication, firmware, or image, or...?

e.g.
"First you flash the OpenWrt factory firmware..."
"First you flash the OpenWrt factory image..."

Although I know that it is a firmware, I would download and flash the image to my router.
But that's only my personal, non-native speaker preference.