Ticket #9508 (closed: fixed)
Clean out Out Of Date Documentation Pages
Reported by: | Karl Palmen | Owned by: | Nick Draper |
---|---|---|---|
Priority: | major | Milestone: | Release 3.2 |
Component: | Documentation | Keywords: | |
Cc: | anders.markvardsen@… | Blocked By: | |
Blocking: | #8917 | Tester: | Michael Reuter |
Description
1) List pages for algorithms that have been removed, so they can be deleted. 2) List pages that should be merged, because they deal with the same topic. 3) Identify other pages obviously out of date.
This covers point 9 in ticket #8917
Change History
comment:4 Changed 6 years ago by Karl Palmen
I've also found references to Subversion that need updating to GIT. I'll list such pages including any I have fixed, because they may need further attention.
comment:5 Changed 6 years ago by Karl Palmen
The only references to 'subversion' I found were in Help: Contents (last edited in 2009) and Eclipse Setup. I've fixed the subversion link in Eclipse Setup, but I expect this page needs further attention.
http://www.mantidproject.org/Eclipse_Setup (last edited, excepted by me 2010).
comment:6 Changed 6 years ago by Karl Palmen
On examining the suspected duplicate pages of http://www.mantidproject.org/Installing_Mantid_On_Linux and http://www.mantidproject.org/Installing_Mantid_Via_Yum , I find that the latter is linked by the former and so seems to be part of it. I don't see a need to merge them, except that the wrong page may be picked up when searching.
comment:7 Changed 6 years ago by Karl Palmen
The following files have been identified as out of date, because they have not been updated since 2009 and by the nature of their topic they require update since then.
http://www.mantidproject.org/Linux_Package_Availability http://www.mantidproject.org/Create_a_build_server http://www.mantidproject.org/Python_Console_Environment http://www.mantidproject.org/Available_Functions
Also possibly pages related to installing QTIPlot.
Also from other knowledge http://www.mantidproject.org/SpectraDetectorMap is out of date.
comment:8 Changed 6 years ago by Karl Palmen
- Status changed from inprogress to verify
- Resolution set to fixed
To test verify that these lists are accurate and sufficient for release 3.2 .
comment:10 Changed 6 years ago by Karl Palmen
- Status changed from verify to reopened
- Resolution fixed deleted
comment:11 Changed 6 years ago by Karl Palmen
I will produce lists for pages to delete, of Historical interest only, need attention of a particular type of expert etc. This lists will have links to enable easy access.
comment:12 Changed 6 years ago by Karl Palmen
RECOMMEMDED FOR REMOVAL
BLANKED All zero byte files in http://www.mantidproject.org/Special:ShortPages - Done http://www.mantidproject.org/Category:Tube_calibration - Done http://www.mantidproject.org/Category:Mathematics - Done http://www.mantidproject.org/Category:GeneralCorrections - Done
TO BE DELETED All 13 byte files in http://www.mantidproject.org/Special:ShortPages - Done
DEPRECATED PYTHON http://www.mantidproject.org/Python_in_Mantid_Training - Done http://www.mantidproject.org/Python_Overview - Done http://www.mantidproject.org/Running_Algorithms_In_Python - Done http://www.mantidproject.org/Getting_Help - Done http://www.mantidproject.org/Combining_Python_and_Mantid - Done http://www.mantidproject.org/Command_Line_Interaction - Done http://www.mantidproject.org/Accessing_Algorithms_and_Workspaces - Done http://www.mantidproject.org/Accessing_MatrixWorkspaces - Done http://www.mantidproject.org/Accessing_TableWorkspaces - Done http://www.mantidproject.org/Accessing_WorkspaceGroups - Done http://www.mantidproject.org/Instrument_Interaction - Done http://www.mantidproject.org/Building_A_Python_Library - Done http://www.mantidproject.org/Python_and_Mantid_Exercise_Solutions - Done http://www.mantidproject.org/Workspace_Algebra - Done
HISTORIC http://www.mantidproject.org/Project_deliverables - Done http://www.mantidproject.org/Project_specifications - Done http://www.mantidproject.org/Current_events - Done http://www.mantidproject.org/Document_repository - Done
GAUDI http://www.mantidproject.org/Creating_a_Data_Object - Done http://www.mantidproject.org/Installing_GAUDI_On_Fedora_7 - Done http://www.mantidproject.org/Creating_a_Simple_Gaudi_Algorithm - Done http://www.mantidproject.org/Adding_and_Retrieving_from_the_TDS - Done http://www.mantidproject.org/PrototypeAims - Done http://www.mantidproject.org/GaudiPrototype - Done http://www.mantidproject.org/GaudiPython - Done http://www.mantidproject.org/Pilot_Architecture_Prototype - Done
INSTALLATION http://www.mantidproject.org/HOWTO - Done http://www.mantidproject.org/QTIPlot_Windows_Build - Done http://www.mantidproject.org/QTiPlot_Distribution_Files - Done http://www.mantidproject.org/Installing_QtiPlot_on_Linux - Done http://www.mantidproject.org/System_Requirements - KEEP http://www.mantidproject.org/QTIPLOT_building_preRequisites - Done http://www.mantidproject.org/Installing_QtiPlot_on_Linux - Done http://www.mantidproject.org/Linux_Package_Availability - KEEP http://www.mantidproject.org/Create_a_build_server - Done http://www.mantidproject.org/QTIPlot_Windows_Build2 - Done http://www.mantidproject.org/Windows_Automatic_Updater - Done Also http://www.mantidproject.org/Documentation#Installation needs updating. - ?
SCONS http://www.mantidproject.org/SCONS_Basics - Done
BOOST PYTHON http://www.mantidproject.org/Wrapping_a_Class_via_Boost_Python - Done http://www.mantidproject.org/Using_Pyste_to_Wrap_Classes - Done http://www.mantidproject.org/Boost_Python_with_gcc - Done http://www.mantidproject.org/Boost.Python_Sandbox - Done
OBSOLETE CONCEPTS http://www.mantidproject.org/SpectraDetectorMap - Done
REPLACEABLE BY CATEGORY http://www.mantidproject.org/Available_Functions
NEED CHECKING
PAGES WITHOUT CONTEXT http://www.mantidproject.org/SwfTest (Nick Draper) - Removed http://www.mantidproject.org/Sandbox (Nick Draper) - Removed http://www.mantidproject.org/Algorithm_to_access_log_values_and_return_the_average_value_over_a_run (Laurent Chapon) - Removed
INCOMPLETE http://www.mantidproject.org/Wikipedia:Books/Mantid_Python (Nick Draper) - Removed
NEEDS UPDATE http://www.mantidproject.org/Python_Console_Environment (Martyn Gigg) http://www.mantidproject.org/Documentation (Whoever deals with Installation documentation)
SHOULD IT BE IN A WIKI? Python Course http://www.mantidproject.org/Python_In_Mantid and all that it links to. If kept in wiki, every page could be renamed to indicate that it is part of a python course. to not make greedy use of namespace and to aid searching. Also it might need to be properly separated from deprecated pages. - Has been separated from deprecated pages
UNUSED FILES: All listed in http://www.mantidproject.org/Special:UnusedFiles - Removed some, Others will need removal later
UNUSED TEMPLATES Five listed in http://www.mantidproject.org/Special:UnusedTemplates - Removed some others stay
OTHERS: http://www.mantidproject.org/Python_in_Mantid_Reference
comment:23 Changed 6 years ago by Nick Draper
- Status changed from reopened to verify
- Resolution set to fixed
Removed the rest of he unused files after removing the algorithms
Moved recommendations that need updating of further consideration to #9709
To Test
Make sure you are looking at the new wiki. Check that the algs, and at least some of these are really gone.
comment:24 Changed 6 years ago by Nick Draper
No code changes!
comment:25 Changed 6 years ago by Michael Reuter
- Status changed from verify to verifying
- Tester set to Michael Reuter
comment:26 Changed 6 years ago by Michael Reuter
- Status changed from verifying to closed
I think that everything that was requested to be deleted has been.
comment:27 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10351
The following algorithms are documented, but are not available from Mantidplot
ApplyGroupingFromMuonNexus, BinToMDHistoWorkspace, CountEventsInPulses, EQSANSReduce, IDAtransmission, IFudge, ILLines, JumpFit, OptimizeExtinctionParameters, SaveDASC.