From mboxrd@z Thu Jan 1 00:00:00 1970 From: Michael Tremer To: development@lists.ipfire.org Subject: Re: [PATCH] manualpages: Complete the list of user manual pages Date: Fri, 10 Dec 2021 09:05:35 +0000 Message-ID: <599D256C-11F0-40CE-8045-5EACE1D775C0@ipfire.org> In-Reply-To: <31C8D89A-2C3C-44FB-9095-0496D1DB5084@gmail.com> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="===============6245726419887977962==" List-Id: --===============6245726419887977962== Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Hello, No need to freak out. We caught this all in the testing phase and that is exa= ctly what it is there for. We just don=E2=80=99t want to break shit in production :) -Michael > On 8 Dec 2021, at 17:35, Jon Murphy wrote: >=20 > My apologies for causing all of the confusion and all of the mailing list n= oise. >=20 > Jon >=20 >> On Dec 8, 2021, at 6:43 AM, Leo Hofmann wrote: >>=20 >> Hi all, >>=20 >> Please excuse the confusion, I'll try to explain. >>=20 >> Most important first: This does not fail in Core 162! >> The code is complete and does not generate errors or incorrect links. >> (I just checked that again and I also always make sure my patches don't br= eak stuff before submitting.) >>=20 >> When I presented the idea on the mailing list in September, I included thr= ee sample links in my patch and asked for help in collecting more. >>=20 >> https://patchwork.ipfire.org/project/ipfire/patch/20210919143444.1739-1-ho= fmann(a)leo-andres.de/ >> https://patchwork.ipfire.org/project/ipfire/patch/20210928110906.1089-1-ho= fmann(a)leo-andres.de/ >>=20 >> The incomplete file had to be there for the code to work and anyone to add= more links to it. But strictly speaking, the feature wasn't yet complete. >>=20 >> I should have made it clearer that the revised patchset did not come with = a complete list either and still required more work. >> This was obvious to me, but I did not communicate it well. I wasn't paying= attention and I do apologize for that. >>=20 >> If we leave it as it is now, core 162 will enable only three links and cor= e 163 will then bring the complete feature. >> The links point to the correct wiki page and appear on the following pages= : Index, PPP setup, QoS >>=20 >> Regards >> Leo >>=20 >> Am 08.12.2021 um 12:29 schrieb Adolf Belka: >>> Hi, >>>=20 >>> On 08/12/2021 11:35, Michael Tremer wrote: >>>> Hello, >>>>=20 >>>> I am quite confused, too. >>>>=20 >>>> I thought all of this was already in the update. We seem to at least be = missing this patch which isn=E2=80=99t a problem. >>>=20 >>> My understanding is that the original patch provided the code to be able = to show the help symbols if there was a link provided but the only link was f= or the main page. This additional patch now provides the list of links for ea= ch of the menu pages in the WUI that have a page in the wiki. >>>=20 >>> Regards, >>>=20 >>> Adolf. >>>=20 >>>> Is there anything else that needs to go into 162 to make this fully work? >>>>=20 >>>> -Michael >>>>=20 >>>>> On 5 Dec 2021, at 17:13, Jon Murphy wrote: >>>>>=20 >>>>> Will this mean the code change is in Core 162 and the manualpages (text= file) will be in Core 163 ? >>>>>=20 >>>>>> On Dec 5, 2021, at 4:37 AM, Peter M=C3=BCller wrote: >>>>>>=20 >>>>>> Hi, >>>>>>=20 >>>>>> this looks good to me. I will apply it into the temporary branch for C= ore Update 163, >>>>>> as C162 is already closed and in testing. >>>>>>=20 >>>>>> Reviewed-by: Peter M=C3=BCller >>>>>>=20 >>>>>> Thanks, and best regards, >>>>>> Peter M=C3=BCller >>>>>>=20 >>>>>>=20 >>>>>>> From: Jon Murphy >>>>>>>=20 >>>>>>> Jon Murphy gathered all the links and made the updated file >>>>>>> available on the mailing list: >>>>>>> https://lists.ipfire.org/pipermail/development/2021-October/011383.ht= ml >>>>>>> https://lists.ipfire.org/pipermail/development/2021-December/011737.h= tml >>>>>>>=20 >>>>>>> With kind permission from him, this patch contains the completed list. >>>>>>> The list was successfully checked with "./make.sh check-manualpages". >>>>>>>=20 >>>>>>> Signed-off-by: Leo-Andres Hofmann >>>>>>> Reported-by: Jon Murphy >>>>>>> --- >>>>>>> config/cfgroot/manualpages | 81 ++++++++++++++++++++++++++++++++++++-- >>>>>>> 1 file changed, 78 insertions(+), 3 deletions(-) >>>>>>>=20 >>>>>>> diff --git a/config/cfgroot/manualpages b/config/cfgroot/manualpages >>>>>>> index e5ab1a13c..97246e6f0 100644 >>>>>>> --- a/config/cfgroot/manualpages >>>>>>> +++ b/config/cfgroot/manualpages >>>>>>> @@ -1,7 +1,82 @@ >>>>>>> -# User manual base URL (without trailing slash) >>>>>>> +# Assign manual page URL path to CGI file ([cgi basename]=3D[path/to= /page]) >>>>>>> + >>>>>>> +# Base URL (without trailing slash) >>>>>>> BASE_URL=3Dhttps://wiki.ipfire.org >>>>>>> +index=3Dconfiguration/system/startpage >>>>>>>=20 >>>>>>> -# Assign manual page URL path to CGI file ([cgi basename]=3D[path/to= /page]) >>>>>>> +# System menu >>>>>>> index=3Dconfiguration/system/startpage >>>>>>> -pppsetup=3Dconfiguration/system/dial >>>>>>> +mail=3Dconfiguration/system/mail_service >>>>>>> +remote=3Dconfiguration/system/ssh >>>>>>> +backup=3Dconfiguration/system/backup >>>>>>> +gui=3Dconfiguration/system/userinterface >>>>>>> +fireinfo=3Dfireinfo >>>>>>> +vulnerabilities=3Dconfiguration/system/vulnerabilities >>>>>>> +shutdown=3Dconfiguration/system/shutdown >>>>>>> +credits=3Dconfiguration/system/credits >>>>>>> + >>>>>>> +# Status menu >>>>>>> +system=3Dconfiguration/status/system >>>>>>> +memory=3Dconfiguration/status/memory >>>>>>> +services=3Dconfiguration/status/services >>>>>>> +media=3Dconfiguration/status/drives >>>>>>> +netexternal=3Dconfiguration/status/network_ext >>>>>>> +netinternal=3Dconfiguration/status/network_int >>>>>>> +netother=3Dconfiguration/status/network_int >>>>>>> +netovpnrw=3Dconfiguration/status/network_ovpnrw >>>>>>> +#netovpnsrv=3D >>>>>>> +hardwaregraphs=3Dconfiguration/status/hardware_diagrams >>>>>>> +entropy=3Dconfiguration/status/entropy >>>>>>> +connections=3Dconfiguration/status/connections >>>>>>> +traffic=3Dconfiguration/status/nettraffic >>>>>>> +#mdstat=3D >>>>>>> + >>>>>>> +# Network menu >>>>>>> +zoneconf=3Dconfiguration/network/zoneconf >>>>>>> +dns=3Ddns >>>>>>> +proxy=3Dconfiguration/network/proxy >>>>>>> +urlfilter=3Dconfiguration/network/proxy/url-filter >>>>>>> +#updatexlrator=3Dconfiguration/network/proxy/update_accelerator >>>>>>> +dhcp=3Dconfiguration/network/dhcp >>>>>>> +captive=3Dconfiguration/network/captive >>>>>>> +connscheduler=3Dconfiguration/network/connectionscheduler >>>>>>> +hosts=3Dconfiguration/network/hosts >>>>>>> +dnsforward=3Dconfiguration/network/dnsforward >>>>>>> +routing=3Dconfiguration/network/static >>>>>>> +mac=3Dconfiguration/network/mac-address >>>>>>> +wakeonlan=3Dconfiguration/network/wake-on-lan >>>>>>> + >>>>>>> +# Services menu >>>>>>> +vpnmain=3Dconfiguration/services/ipsec >>>>>>> +ovpnmain=3Dconfiguration/services/openvpn >>>>>>> +ddns=3Dconfiguration/services/dyndns >>>>>>> +time=3Dconfiguration/services/ntp >>>>>>> qos=3Dconfiguration/services/qos >>>>>>> +extrahd=3Dconfiguration/services/extrahd >>>>>>> + >>>>>>> +# Firewall menu >>>>>>> +firewall=3Dconfiguration/firewall >>>>>>> +fwhosts=3Dconfiguration/firewall/fwgroups >>>>>>> +optionsfw=3Dconfiguration/firewall/options >>>>>>> +ids=3Dconfiguration/firewall/ips >>>>>>> +p2p-block=3Dconfiguration/firewall/p2p-block >>>>>>> +location-block=3Dconfiguration/firewall/geoip-block >>>>>>> +wireless=3Dconfiguration/firewall/accesstoblue >>>>>>> +iptables=3Dconfiguration/firewall/iptables >>>>>>> + >>>>>>> +# IPfire menu >>>>>>> +pakfire=3Dconfiguration/ipfire/pakfire >>>>>>> + >>>>>>> +# Logs menu >>>>>>> +summary=3Dconfiguration/logs/summary >>>>>>> +config=3Dconfiguration/logs/logsettings >>>>>>> +proxylog=3Dconfiguration/logs/proxy >>>>>>> +calamaris=3Dconfiguration/logs/proxyreports >>>>>>> +firewalllog=3Dconfiguration/logs/firewall >>>>>>> +firewalllogip=3Dconfiguration/logs/firewall-ip >>>>>>> +firewalllogport=3Dconfiguration/logs/firewall-port >>>>>>> +firewalllogcountry=3Dconfiguration/logs/firewall-country >>>>>>> +ids=3Dconfiguration/logs/ips >>>>>>> +#ovpnclients=3D >>>>>>> +urlfilter=3Dconfiguration/logs/url-filter >>>>>>> +log=3Dconfiguration/logs/system >>>>>>>=20 >=20 --===============6245726419887977962==--