Robotics StackExchange | Archived questions

Is there a procedure for removing obsolete documentation?

As a specific example, this tutorial is heavily outdated (still referring to rosbuild and using roslib.load_manifest) and seems to be superseeded by this and this tutorial. Is there any procedure for removing the obsolete tutorial (as it is likely to confuse newcomers)?

Asked by damjan on 2017-07-09 10:15:34 UTC

Comments

Answers

No, I don't think there is a standardised procedure. As it's a wiki, pages are either updated or removed.

In this case, I would recommend to update the page by using the Buildsystem(..) macro.

That should make it possible to provide proper instructions for both rosbuild and Catkin`.

Asked by gvdhoorn on 2017-07-09 11:11:07 UTC

Comments

I'm actually be in favor of removing it completely, as I think it duplicates information better presented here and here

Asked by damjan on 2017-07-10 03:36:27 UTC

Those two tutorials do seem to cover about the same content, yes. They do separate things into two tutorials, which aren't so clearly linked (well, there is the next tutorial at the top, but that might not be apparent when you get to the bottom of the page).

Asked by gvdhoorn on 2017-07-10 03:39:52 UTC

If after a careful inspection and comparison of those three pages you still feel that they cover the same content, then I would think deleting the old one would be acceptable.

It's a wiki, so after you've received write access, go ahead and remove the old page.

Asked by gvdhoorn on 2017-07-10 03:40:54 UTC

I've reviewed all three pages and I still feel the one I mention is obsolete. However, I have another concern now, which is possible links to the deleted page which will become invalidated. I've tried using the <<FullSearch(linkto:BackLinks)>> macro, but it doesn't seem to work.

Asked by damjan on 2017-07-11 08:33:50 UTC

According to General Page Infos the only page that links to it is the dynamic_reconfigure page.

Asked by gvdhoorn on 2017-07-11 08:37:05 UTC

I'm unable to delete the page (can't see a "Delete" button and deleting all content and saving is disabled). Should I open up a thread on discourse.ros.org to discuss this further? I think a documented wiki page removal procedure might be a good idea.

Asked by damjan on 2017-07-11 08:37:46 UTC

re: discourse: sounds like a good idea.

The answer to your question here is basically: no, there is no documented procedure. The discourse discussion could be about setting up and documenting such a procedure.

Asked by gvdhoorn on 2017-07-11 08:53:19 UTC