From 8545eae19834b46ca2f0efcc717cbf62d2ffc8f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Karel=20Ko=C4=8D=C3=AD?= Date: Mon, 13 May 2019 17:56:49 +0200 Subject: [PATCH] pkglists: update format to support URL and support This adds additional fields with URL and boolean identifying supported lists. --- updater/pkglists/Makefile | 4 +-- updater/pkglists/files/README.md | 14 +++++---- updater/pkglists/files/definitions.json | 38 ++++++++++++++----------- 3 files changed, 32 insertions(+), 24 deletions(-) diff --git a/updater/pkglists/Makefile b/updater/pkglists/Makefile index 079f90cdb..f9d893553 100644 --- a/updater/pkglists/Makefile +++ b/updater/pkglists/Makefile @@ -8,8 +8,8 @@ include $(TOPDIR)/rules.mk PKG_NAME:=pkglists -PKG_VERSION:=1.0.6 -PKG_RELEASE:=2 +PKG_VERSION:=1.1 +PKG_RELEASE:=1 PKG_MAINTAINER:=CZ.NIC PKG_BUILD_DIR:=$(BUILD_DIR)/$(PKG_NAME) diff --git a/updater/pkglists/files/README.md b/updater/pkglists/files/README.md index adc9e421c..9787c22e0 100644 --- a/updater/pkglists/files/README.md +++ b/updater/pkglists/files/README.md @@ -1,15 +1,19 @@ -User lists definitions ----------------------- -Definitions are in JSON file format. It's expected to contain name of user list +Package lists definitions +------------------------- +Definitions are in JSON file format. It's expected to contain name of package list and for that there should be following fields: * __title__: This is suppose to be a title for given user list. Type is string. * __description__: This is long text describing content of given user list. Type is string. +* __url__: This is URL to documentation. It is not required. Type is string. * __visible__: This should be set to `yes` or `no` to say if given user list - should be visible or not. Type is boolean. + should be visible or not. If not specified then `true` is used. Type is boolean. +* __official__: This differentiates between officially supported and community + supported lists. If not specified then `false` is used. Type is boolean. -All fields has to be defined as appropriate values of specified type. +All fields has to be defined as appropriate values of specified type unless stated +otherwise. ### Translations To generate translations you can use `gen_pot.py` script. It expect you to run it diff --git a/updater/pkglists/files/definitions.json b/updater/pkglists/files/definitions.json index c98f0c786..3e2ae38cb 100644 --- a/updater/pkglists/files/definitions.json +++ b/updater/pkglists/files/definitions.json @@ -2,71 +2,75 @@ "3g": { "title": "Extensions of network protocols for 3G/LTE", "description": "Support for additional protocols and connection types.", - "visible": true + "official": true }, "datacollect": { "title": "Data Collection", "description": "Software for participation in data collection and dynamic distributed firewall.", - "visible": true + "url": "https://doc.turris.cz/doc/en/howto/collect", + "official": true }, "dev-detect": { "title": "Device detection", "description": "Software for detecting new devices on local network (EXPERIMENTAL).", - "visible": true + "official": true }, "dvb": { "title": "DVB tuner", "description": "Software for sharing television received by a DVB tuner on Turris. Does not include device drivers.", - "visible": true + "url": "https://doc.turris.cz/doc/en/howto/dvb" }, "honeypot": { "title": "SSH Honeypot", "description": "Trap for password-guessing robots on SSH.", - "visible": true + "official": true }, "luci-controls": { "title": "LuCI extensions", - "description": "Several addional tabs and controls for the advanced LuCI interface.", - "visible": true + "description": "Several addional tabs and controls for the advanced LuCI interface." }, "lxc": { "title": "LXC utilities", "description": "Set of utilities to manage Linux Containers (lightweight virtualization technology).", - "visible": true + "url": "https://doc.turris.cz/doc/en/howto/lxc", + "official": true }, "nas": { "title": "NAS", "description": "Services allowing to connect a disk to the router and use it as network data store.", - "visible": true + "url": "https://doc.turris.cz/doc/en/howto/nas", + "official": true }, "netboot": { "title": "Turris MOX network boot", - "description": "Server side for Turris MOX without SD card used as Wi-Fi access point.", - "visible": false + "description": "Server side for Turris MOX without SD card used as Wi-Fi access point. (EXPERIMENTAL)", + "official": true }, "netmetr": { "title": "Internet connection speed measurement", "description": "Actively measures speed of Internet connection using netmetr.cz service.", - "visible": true + "url": "https://www.netmetr.cz", + "official": true }, "openvpn": { "title": "OpenVPN", "description": "An easy setup of OpenVPN server from Foris.", - "visible": true + "url": "https://doc.turris.cz/doc/en/howto/openvpn_plugin", + "official": true }, "pakon": { "title": "Pakon", "description": "Software for in depth monitoring of your traffic.", - "visible": true + "url": "https://doc.turris.cz/doc/en/howto/pakon", + "official": true }, "printserver": { "title": "Print server", "description": "Services allowing to connect a printer to the router and use it for remote printing.", - "visible": true + "url": "https://doc.turris.cz/doc/en/howto/printer_sharing" }, "tor": { "title": "Tor", - "description": "Service to increase anonymity on the Internet.", - "visible": true + "description": "Service to increase anonymity on the Internet." } } -- GitLab