freifunk-franken
/
docs
4
0
Fork 4
Code Issues 14 Pull Requests 6 Releases Activity

add infrastructure for hardware database #22

Open
jkimmel wants to merge 3 commits from jkimmel/docs:hw into master
pull from: jkimmel/docs:hw
merge into: freifunk-franken:master
Conversation 1 Commits 3 Files Changed 7 +380 -1
jkimmel commented 2023-02-23 16:31:10 +01:00
Owner
Copy Link

To keep device information consistent, use a small per device database
embedded in the frontmatter of the device page source.

Device information is extracted from the database and formatted into
tables with the provided shortcodes

The data can then further be used to build comparison tables and filters for
specific usecases.

New devices should make use of the provided archetype, which provides an
example of most used fields:

hugo new content/hardware/my-device.md
To keep device information consistent, use a small per device database embedded in the frontmatter of the device page source. Device information is extracted from the database and formatted into tables with the provided shortcodes The data can then further be used to build comparison tables and filters for specific usecases. New devices should make use of the provided archetype, which provides an example of most used fields: ``` hugo new content/hardware/my-device.md ```
jkimmel force-pushed hw from 4bed50edd0 to 49b8de939d 2023-02-23 16:32:01 +01:00 Compare
jkimmel force-pushed hw from 49b8de939d to 2393201ce3 2023-02-23 16:32:25 +01:00 Compare
jkimmel commented 2023-03-01 20:54:06 +01:00
Author
Owner
Copy Link

Sinnvoll wären noch direkte Downloadlinks automatisch zu erzeugen. Dazu ist folgendes nötig:

  • Firmware Datum YYYYMMDD global in params a74cde38db/config.yaml (L17) ablegen
  • Struktur mit Namensschema 
    download:
  layer3:
    - url: -$device-sysupgrade.bin
      usage: Firmware Updates
    - url: -$device-factory.img
      usage: Erstinstallation
  node:
    - ...
    Am besten explizit alle gültigen URLs, getrennt nach layer3 und node, weil nicht garantiert ist, dass es für ein Gerät beide Firmwareversionen gibt.
  • Tabelle mit direkten Download links + Beschreibung kann dann erzeugt werden (Skizze): 
    https://dev.freifunk-franken.de/{{ .firmware }}/{{ .Site.Params.firmware_version }}/fff-{{ .firmware }}-{{ .Site.Params.firmware_version }}-{{ .url }}

    https://dev.freifunk-franken.de/node/20221201/fff-node-20221201-tplink_archer-c50-v4-sysupgrade.bin
  • Bei Firmwareupdates Datum anpassen und Seite neu rendern.
Sinnvoll wären noch direkte Downloadlinks automatisch zu erzeugen. Dazu ist folgendes nötig: - Firmware Datum `YYYYMMDD` global in `params` https://git.freifunk-franken.de/freifunk-franken/docs/src/commit/a74cde38db8123c6ba4d1c396d2aa0b982d064e9/config.yaml#L17 ablegen - Struktur mit Namensschema ```yaml download: layer3: - url: -$device-sysupgrade.bin usage: Firmware Updates - url: -$device-factory.img usage: Erstinstallation node: - ... ``` Am besten explizit alle gültigen URLs, getrennt nach `layer3` und `node`, weil nicht garantiert ist, dass es für ein Gerät beide Firmwareversionen gibt. - Tabelle mit direkten Download links + Beschreibung kann dann erzeugt werden (Skizze): ``` https://dev.freifunk-franken.de/{{ .firmware }}/{{ .Site.Params.firmware_version }}/fff-{{ .firmware }}-{{ .Site.Params.firmware_version }}-{{ .url }} ``` ``` https://dev.freifunk-franken.de/node/20221201/fff-node-20221201-tplink_archer-c50-v4-sysupgrade.bin ``` - Bei Firmwareupdates Datum anpassen und Seite neu rendern.
jkimmel force-pushed hw from 2393201ce3 to c2e790bbd6 2023-03-01 21:40:50 +01:00 Compare
jkimmel force-pushed hw from c2e790bbd6 to cde207419c 2023-03-01 21:42:12 +01:00 Compare
jkimmel force-pushed hw from cde207419c to 61bad2dade 2023-03-01 21:56:25 +01:00 Compare
jkimmel force-pushed hw from 61bad2dade to 168781074b 2023-03-01 21:57:21 +01:00 Compare
jkimmel force-pushed hw from 0f8ff82c34 to b337289a5b 2023-03-01 22:48:21 +01:00 Compare
jkimmel force-pushed hw from b337289a5b to 2ab4b6f154 2023-03-01 22:50:40 +01:00 Compare
jkimmel force-pushed hw from 2ab4b6f154 to 29f583a250 2023-03-30 15:44:08 +02:00 Compare
All checks were successful
01-env build environment
Details
02-git-checkout git checkout
Details
03-hugo-version hugo version
Details
04-hugo-build hugo build
Details
05-preview website preview
Details
This pull request can be merged automatically.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
You can also view command line instructions.

Step 1:

From your project repository, check out a new branch and test the changes.
git checkout -b jkimmel-hw master
git pull hw

Step 2:

Merge the changes and update on Gitea.
git checkout master
git merge --no-ff jkimmel-hw
git push origin master
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
bug

Something is not working

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
good first issue

This issue would be a good issue for a first time contributor to undertake.

  
help wanted

Need some help

  
invalid

Something is wrong

  
question

More information is needed

  
wontfix

This won't be fixed

No Label
bug
duplicate
enhancement
good first issue
help wanted
invalid
question
wontfix
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: freifunk-franken/docs#22
No description provided.
Delete Branch "jkimmel/docs:hw"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?