Re: old install to a different folder
On 11/14/22 02:21, Gerald Pfeifer wrote: > On Sun, 13 Nov 2022, Martin Liška wrote: >> So Gerald, I'm suggesting a new url base gcc.gnu.org/docs that will be >> filled with the new manuals and gcc.gnu.org/onlinedocs/$man and >> gcc.gnu.org/install locations should point to older (trunk) manuals >> (prev folder at server I guess). Having that, the new manuals will not >> available through navigation and will get some time for further changes. > > I feel I may be missing something. > > Why don't we > > (1a) keep /onlinedocs for all docs < GCC 13, > (1b) possibly introduce /docs as an alternative URL (though we need > to keep /onlinedocs for all the existing ones), > > (2) add sphinx docs for trunk, GCC 13 and later to /docs (and at the > same time /onlinedocs which is just an alias) > > (3) put current installation documentation under /install and simply > add a few redirects for those pages that have changed names? > > That way we can retain existing structures, possibly replace /onlinedocs > for the shorter /docs, and have one consistent index for all manuals. > > Gerald Hello. Note the Sphinx changes will be reverted today: https://gcc.gnu.org/pipermail/gcc/2022-November/239983.html That said, we won't need to come up with a new sub-url. Martin
Re: old install to a different folder
On Sun, 13 Nov 2022, Martin Liška wrote: > So Gerald, I'm suggesting a new url base gcc.gnu.org/docs that will be > filled with the new manuals and gcc.gnu.org/onlinedocs/$man and > gcc.gnu.org/install locations should point to older (trunk) manuals > (prev folder at server I guess). Having that, the new manuals will not > available through navigation and will get some time for further changes. I feel I may be missing something. Why don't we (1a) keep /onlinedocs for all docs < GCC 13, (1b) possibly introduce /docs as an alternative URL (though we need to keep /onlinedocs for all the existing ones), (2) add sphinx docs for trunk, GCC 13 and later to /docs (and at the same time /onlinedocs which is just an alias) (3) put current installation documentation under /install and simply add a few redirects for those pages that have changed names? That way we can retain existing structures, possibly replace /onlinedocs for the shorter /docs, and have one consistent index for all manuals. Gerald
Re: old install to a different folder
On 11/12/22 01:06, Joseph Myers wrote: > On Fri, 11 Nov 2022, Tobias Burnus wrote: > >> For /onlinedocs/, I concur that we want to have the old doc there as there >> are >> many >> deep links. Still, we should consider adding a disclaimer box to all former >> mainline >> documentation stating that this data is no longer updated + point to the new >> overview >> page + we could redirect access which goes directly to '//' and >> not a (sub)html >> page to the new site, as you proposed. > > Note that if we do this, I think my previous comments (to keep the > unmodified files somewhere long-term outside the directory served by the > webserver, with an automated process for modifying headers, so that > modified versions of that process can be re-run in future if we have > further changes to apply to the added headers) apply to such old mainline > documentation just as to release documentation. > Hello. So I in context of [1] and [2] we will have to move content in between files and thus newly taken URLs (from gcc.gnu.org/onlinedocs/$man and gcc.gnu.org/install) can get invalid. So Gerald, I'm suggesting a new url base gcc.gnu.org/docs that will be filled with the new manuals and gcc.gnu.org/onlinedocs/$man and gcc.gnu.org/install locations should point to older (trunk) manuals (prev folder at server I guess). Having that, the new manuals will not available through navigation and will get some time for further changes. Thanks. Martin [1] https://gcc.gnu.org/pipermail/gcc/2022-November/239922.html [2] https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107634
Re: old install to a different folder
On Fri, 11 Nov 2022, Tobias Burnus wrote: > For /onlinedocs/, I concur that we want to have the old doc there as there are > many > deep links. Still, we should consider adding a disclaimer box to all former > mainline > documentation stating that this data is no longer updated + point to the new > overview > page + we could redirect access which goes directly to '//' and > not a (sub)html > page to the new site, as you proposed. Note that if we do this, I think my previous comments (to keep the unmodified files somewhere long-term outside the directory served by the webserver, with an automated process for modifying headers, so that modified versions of that process can be re-run in future if we have further changes to apply to the added headers) apply to such old mainline documentation just as to release documentation. -- Joseph S. Myers jos...@codesourcery.com
Re: old install to a different folder
Hi Richard, On 11.11.22 11:18, Richard Bienr wrote: Note I think we can "remove" the install/ and onlinedocs/ _landing_ pages (index.html) but we should keep the actual content pages so old links keep working. We can also replace the landing pages with a pointer to the new documentation (or plain re-direct to that!). For install, I think we should consider to redirect. Before the move to Sphinx, we had only: binaries.html build.html configure.html download.html finalinstall.html gfdl.html index.html prerequisites.html specific.html test.html Re-directing them to the new pages will work. There is a one-to-one correspondence for all but build/test which are now in 7* and 5 files, respectively. Still linking to the outermost should be ok as I do not think that there will be many links using '#...'. (*The subdivision is also a bit pointless for Ada and D as it consists only of the texts "GNAT prerequisites." and "GDC prerequisites.", respectively (in the old doc). In the Sphinx docs, it is even shortened to: "GNAT." and "GDC.".) The only except where links to page anchors are likely used is for "Host/target specific installation notes for GCC". For them, some like '#avr' still works while others don't (like 'nvptx-*-none' as '#nvptx-x-none' changed to '#nvptx-none'). But the page is short enough and it is clear from the context what the user wants - there is also a table of content on the right to click on. (IMHO that's sufficient.) * * * For /onlinedocs/, I concur that we want to have the old doc there as there are many deep links. Still, we should consider adding a disclaimer box to all former mainline documentation stating that this data is no longer updated + point to the new overview page + we could redirect access which goes directly to '//' and not a (sub)html page to the new site, as you proposed. Tobias - Siemens Electronic Design Automation GmbH; Anschrift: Arnulfstraße 201, 80634 München; Gesellschaft mit beschränkter Haftung; Geschäftsführer: Thomas Heurung, Frank Thürauf; Sitz der Gesellschaft: München; Registergericht München, HRB 106955
Re: old install to a different folder
On 11/11/22 11:18, Richard Biener wrote: > On Fri, Nov 11, 2022 at 10:12 AM Tobias Burnus > wrote: >> >> On 11.11.22 09:50, Martin Liška wrote: >>> I do support the Richi's idea about using a new URL for the new Sphinx >>> documentation >>> while keeping the older Texinfo documentation under /onlinedocs and /install >> >> If we do so and those become then static files: Can we put some >> disclaimer at the top of all HTML files under /install/ and under >> /onlinedocs// that those are legacy files and the new >> documentation can be found under (not a deep link but directly to >> the install pages or the new overview page about the Sphinx docs). >> >> I think we really need such a hint – otherwise it is more confusing than >> helpful! Additionally, we should add a "news" entry to the mainpage >> pointing out that it changed and linking to the new Sphinx doc. > > Note I think we can "remove" the install/ and onlinedocs/ _landing_ pages > (index.html) but we should keep the actual content pages so old links keep > working. We can also replace the landing pages with a pointer to the new > documentation (or plain re-direct to that!). Even better. So let me summarize it: gcc.gnu.org/docs - will contain newly generated Sphinx documentation gcc.gnu.org/docs/gcc - sub-folder example gcc.gnu.org/docs/install - sub-folder example gcc.gnu.org/docs/gcc-13.1.0/install - sub-folder example once we'll have GCC 13.1 release gcc.gnu.org/install/index.html - 301 to gcc.gnu.org/docs/install gcc.gnu.org/install/$something - point to old install manual gcc.gnu.org/onlinedocs/index.html - 301 to gcc.gnu.org/docs/ gcc.gnu.org/onlinedocs/$something - point to old GCC manual @Gerald: Is it something you can set-up? What do you think about it? Martin > > Richard. > >> Tobias >> >> - >> Siemens Electronic Design Automation GmbH; Anschrift: Arnulfstraße 201, >> 80634 München; Gesellschaft mit beschränkter Haftung; Geschäftsführer: >> Thomas Heurung, Frank Thürauf; Sitz der Gesellschaft: München; >> Registergericht München, HRB 106955
Re: old install to a different folder
On Fri, Nov 11, 2022 at 10:12 AM Tobias Burnus wrote: > > On 11.11.22 09:50, Martin Liška wrote: > > I do support the Richi's idea about using a new URL for the new Sphinx > > documentation > > while keeping the older Texinfo documentation under /onlinedocs and /install > > If we do so and those become then static files: Can we put some > disclaimer at the top of all HTML files under /install/ and under > /onlinedocs// that those are legacy files and the new > documentation can be found under (not a deep link but directly to > the install pages or the new overview page about the Sphinx docs). > > I think we really need such a hint – otherwise it is more confusing than > helpful! Additionally, we should add a "news" entry to the mainpage > pointing out that it changed and linking to the new Sphinx doc. Note I think we can "remove" the install/ and onlinedocs/ _landing_ pages (index.html) but we should keep the actual content pages so old links keep working. We can also replace the landing pages with a pointer to the new documentation (or plain re-direct to that!). Richard. > Tobias > > - > Siemens Electronic Design Automation GmbH; Anschrift: Arnulfstraße 201, 80634 > München; Gesellschaft mit beschränkter Haftung; Geschäftsführer: Thomas > Heurung, Frank Thürauf; Sitz der Gesellschaft: München; Registergericht > München, HRB 106955
Re: old install to a different folder
On 11.11.22 09:50, Martin Liška wrote: I do support the Richi's idea about using a new URL for the new Sphinx documentation while keeping the older Texinfo documentation under /onlinedocs and /install If we do so and those become then static files: Can we put some disclaimer at the top of all HTML files under /install/ and under /onlinedocs// that those are legacy files and the new documentation can be found under (not a deep link but directly to the install pages or the new overview page about the Sphinx docs). I think we really need such a hint – otherwise it is more confusing than helpful! Additionally, we should add a "news" entry to the mainpage pointing out that it changed and linking to the new Sphinx doc. Tobias - Siemens Electronic Design Automation GmbH; Anschrift: Arnulfstraße 201, 80634 München; Gesellschaft mit beschränkter Haftung; Geschäftsführer: Thomas Heurung, Frank Thürauf; Sitz der Gesellschaft: München; Registergericht München, HRB 106955
Re: old install to a different folder
On 11/11/22 09:40, Tobias Burnus wrote: > However, others might have different ideas. Note that this was discussed in > the thread "Links to web pages are broken." Yes, please discuss this further in the aforementioned thread. I do support the Richi's idea about using a new URL for the new Sphinx documentation while keeping the older Texinfo documentation under /onlinedocs and /install Martin
Re: old install to a different folder
Hi Gerald, On 10.11.22 20:24, Gerald Pfeifer wrote: On Thu, 10 Nov 2022, Martin Liška wrote: We noticed we'll need the old /install to be available for redirect. Gerald, can you please put it somewhere under /install-prev, or something similar? I'm afraid I am confused now. Based on your original request I had removed the original /install directoy. I think we just need to handle more. Namely: * Links directly to https://gcc.gnu.org/install/ this works and shows the new page. * Sublinks - those currently fail as the name has changed: https://gcc.gnu.org/install/configure.html (which is now https://gcc.gnu.org/install/configuration.html ) https://gcc.gnu.org/install/build.html (now: https://gcc.gnu.org/install/building.html ) https://gcc.gnu.org/install/specific.html#avr → https://gcc.gnu.org/install/host-target-specific-installation-notes-for-gcc.html#avr My impression is that it is sufficient to handle those renamings and we do not need the old pages. However, others might have different ideas. Note that this was discussed in the thread "Links to web pages are broken." Tobias - Siemens Electronic Design Automation GmbH; Anschrift: Arnulfstraße 201, 80634 München; Gesellschaft mit beschränkter Haftung; Geschäftsführer: Thomas Heurung, Frank Thürauf; Sitz der Gesellschaft: München; Registergericht München, HRB 106955
Re: old install to a different folder
On Thu, 10 Nov 2022, Martin Liška wrote: > We noticed we'll need the old /install to be available for redirect. > > Gerald, can you please put it somewhere under /install-prev, or > something similar? I'm afraid I am confused now. Based on your original request I had removed the original /install directoy. Can you help me understand what exactly we need and what for (in the big picture)? And I'll then see how I can help. Gerald
