Links to documents not automatically updated

Bug #1860578 reported by Rod Smith
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
maas-cert-server
New
Undecided
Unassigned

Bug Description

The certification-docs 0.3.1 package, and matching maas-cert-server 0.4.5 package, introduced a change to the name of MANIACS and its filenames, from MAAS_Advanced_NUC_Installation_And_Configuration_Scripted.* to MAAS_Advanced_Network_Installation_And_Configuration_Scripted.*. Although these packages included all the necessary renames, the link on the installed server's index page was dead -- that is, clicking "Read the MAAS Advanced Network Installation and Configuration—Scripted (MANIACS) document in HTML form" (or "...in PDF form") produced a "not found" error.

The cause is that the links are set up in the maniacs-setup script, not inherent in the packaging. Specifically, the setup_weblinks() function in maniacs-setup creates the links, and if a filename changes or if a file is added to the packaging, that change won't be reflected on the web server unless and until maniacs-setup is run again. The setup_weblinks() function is run unconditionally on any run of the script, so running it with any options should fix the problem. In a test, I ran "maniacs-setup -p" to update the preseed file and that fixed the problem.

Ideally, we should have a way to update the links automatically when the maas-cert-server package is installed or updated. Alternatively, and perhaps better, the locations of the files should be changed such that we don't rely on symbolic links to individual files; a symbolic link to the documentation directory, with paths in the HTML file to include an extra subdirectory, would be more robust than the current configuration.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.