From mboxrd@z Thu Jan 1 00:00:00 1970 From: Leo Hofmann To: development@lists.ipfire.org Subject: Re: [PATCH] manualpages: Complete the list of user manual pages Date: Wed, 08 Dec 2021 13:43:01 +0100 Message-ID: <50439c10-3b46-8292-0b4f-316ad8aa7be8@leo-andres.de> In-Reply-To: <3086aaf8-a112-d3fa-efaf-dcdd41b119a4@ipfire.org> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="===============8097889542877910416==" List-Id: --===============8097889542877910416== Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Hi all, Please excuse the confusion, I'll try to explain. 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 break= stuff before submitting.) When I presented the idea on the mailing list in September, I included three = sample links in my patch and asked for help in collecting more. https://patchwork.ipfire.org/project/ipfire/patch/20210919143444.1739-1-hofma= nn(a)leo-andres.de/ https://patchwork.ipfire.org/project/ipfire/patch/20210928110906.1089-1-hofma= nn(a)leo-andres.de/ The incomplete file had to be there for the code to work and anyone to add mo= re links to it. But strictly speaking, the feature wasn't yet complete. I should have made it clearer that the revised patchset did not come with a c= omplete list either and still required more work. This was obvious to me, but I did not communicate it well. I wasn't paying at= tention and I do apologize for that. If we leave it as it is now, core 162 will enable only three links and core 1= 63 will then bring the complete feature. The links point to the correct wiki page and appear on the following pages: I= ndex, PPP setup, QoS Regards Leo Am 08.12.2021 um 12:29 schrieb Adolf Belka: > Hi, > > On 08/12/2021 11:35, Michael Tremer wrote: >> Hello, >> >> I am quite confused, too. >> >> I thought all of this was already in the update. We seem to at least be mi= ssing this patch which isn=E2=80=99t a problem. > > 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 for= the main page. This additional patch now provides the list of links for each= of the menu pages in the WUI that have a page in the wiki. > > Regards, > > Adolf. > >> Is there anything else that needs to go into 162 to make this fully work? >> >> -Michael >> >>> On 5 Dec 2021, at 17:13, Jon Murphy wrote: >>> >>> Will this mean the code change is in Core 162 and the manualpages (text f= ile) will be in Core 163 ? >>> >>>> On Dec 5, 2021, at 4:37 AM, Peter M=C3=BCller wrote: >>>> >>>> Hi, >>>> >>>> this looks good to me. I will apply it into the temporary branch for Cor= e Update 163, >>>> as C162 is already closed and in testing. >>>> >>>> Reviewed-by: Peter M=C3=BCller >>>> >>>> Thanks, and best regards, >>>> Peter M=C3=BCller >>>> >>>> >>>>> From: Jon Murphy >>>>> >>>>> 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.html >>>>> https://lists.ipfire.org/pipermail/development/2021-December/011737.html >>>>> >>>>> With kind permission from him, this patch contains the completed list. >>>>> The list was successfully checked with "./make.sh check-manualpages". >>>>> >>>>> Signed-off-by: Leo-Andres Hofmann >>>>> Reported-by: Jon Murphy >>>>> --- >>>>> config/cfgroot/manualpages | 81 ++++++++++++++++++++++++++++++++++++-- >>>>> 1 file changed, 78 insertions(+), 3 deletions(-) >>>>> >>>>> 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/p= age]) >>>>> + >>>>> +# Base URL (without trailing slash) >>>>> BASE_URL=3Dhttps://wiki.ipfire.org >>>>> +index=3Dconfiguration/system/startpage >>>>> >>>>> -# Assign manual page URL path to CGI file ([cgi basename]=3D[path/to/p= age]) >>>>> +#=C2=A0=C2=A0=C2=A0 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 >>>>> + >>>>> +#=C2=A0=C2=A0=C2=A0 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 >>>>> + >>>>> +#=C2=A0=C2=A0=C2=A0 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 >>>>> + >>>>> +#=C2=A0=C2=A0=C2=A0 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 >>>>> + >>>>> +#=C2=A0=C2=A0=C2=A0 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 >>>>> + >>>>> +#=C2=A0=C2=A0=C2=A0 IPfire menu >>>>> +pakfire=3Dconfiguration/ipfire/pakfire >>>>> + >>>>> +#=C2=A0=C2=A0=C2=A0 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 >>>>> --===============8097889542877910416==--