View Issue Details

IDProjectCategoryView StatusLast Update
0001968Slicer4Core: Documentation and Wikipublic2017-06-07 13:48
Reporterjcfr Assigned Togrundlett  
PrioritynormalSeverityminorReproducibilityhave not tried
Status closedResolutionfixed 
Product Version 
Target VersionSlicer 4.3.0Fixed in VersionSlicer 4.3.0 
Summary0001968: Setup robot.txt so that only current stable version of Slicer documentation is indexed
Description

See http://www.mediawiki.org/wiki/Manual:Robots.txt

The following pages should be excluded:

index.php/Documentation/4.0/
index.php/Template:

May be documentation associated with slicer 3.6, 3.5 etc .. should also be excluded ?

Additional Information

From Greg Sharp - april 12th 2012:

Hi,

I just noticed today, when I use a common, commercial search
engine to find the Slicer documentation, the pages for
version 4.0 appeared higher in the list than documentation
for version 4.1. This caused me to refer to an old version
of the documentation.

Of course ok for me, but I think it can be confusing for
new users to get the old documentation.

Greg

TagsNo tags attached.

Relationships

related to 0002887 closedjcfr Minimize confusion by adding disclaimer on top of old wiki page 
related to 0002905 closedjcfr Create redirect from Latest to current stable version on the wiki 

Activities

jcfr

jcfr

2012-05-01 15:19

administrator   ~0004119

Could also use the magic word NOINDEX
See http://www.mediawiki.org/wiki/Help:Magic_words

mhalle

mhalle

2012-05-01 19:53

developer   ~0004120

I don't think "unindexing" content is the best solution here.

First, disabling crawling doesn't clear the index. It take a long time for that information to expire.

Second, that content may still be useful to someone. That's especially true of the 3.X documentation.

Third, I'd like to see what the best practices are. For instance, I get old versions of the VTK docs all the time when I do a search. Same for python sometimes. That's not great, but it is predictable and understandable behavior.

The alternative fixes are to

1) provide pointers to the most current documents at the top of the 4.0 pages (that's what W3C standards do -- always maintain a "latest" pointer)

2) Have a "latest" version on the wiki that redirects or is copied in some way,

3) Have documents that describe current behavior as well as recent changes (for example, the python docs say "since version 2.6" or "added in 2.5").

jcfr

jcfr

2012-05-02 06:52

administrator   ~0004124

Good point. Will think about it. Assigned the issue back to me.

jcfr

jcfr

2012-05-03 14:11

administrator   ~0004156

From Lauren - May 3, 2012:

you could do what NIH does for old grant info pages, or what amazon does so that people know the model number is old, edit the top of the page with info pointing to the current version

or have wiki URLS that point to Current, and redo those links when the latest stable version changes, maybe they will accumulate more google cred since they are longer lasting URLs

my 2 cents

jcfr

jcfr

2013-06-14 19:32

administrator   ~0008774

Closing the issue because the approach used in 0002887 achieves the same purpose.

jcfr

jcfr

2013-06-14 19:34

administrator   ~0008775

Reminder sent to: gregsharp

Hi Greg, I believe the confusion between different version of the documentation has been removed. For details, see 0002887.

Let me know what you think.

jcfr

jcfr

2014-03-06 04:56

administrator   ~0010795

Closing resolved issues that have not been updated in more than 3 months

grundlett

grundlett

2017-06-07 08:40

administrator   ~0014528

Documentation references version numbering. See https://www.slicer.org/wiki/Documentation/4.6/HowTo

jcfr

jcfr

2017-06-07 09:55

administrator   ~0014531

Documentation references version numbering. See https://www.slicer.org/wiki/Documentation/4.6/HowTo

Does this mean only 4.7 documentation is indexed now ?

grundlett

grundlett

2017-06-07 10:43

administrator   ~0014532

No, I'm saying robots.txt does not inhibit indexing of documentation. The principles laid out in the HowTo describe the structure, versioning and navigation of documentation resources for all versions of Slicer.

jcfr

jcfr

2017-06-07 11:53

administrator   ~0014534

Sorry for the noise. I initially thought you closed the issue ... but I did a while back. That is why I got confused ... oops.

That said, do you know of way to favor indexing of a given set of pages ?

grundlett

grundlett

2017-06-07 12:52

administrator   ~0014535

Make sure it's mobile-friendly. And use meta tags to ensure that relevant search terms are present aka "Documentation" is on the right page set and "Old Documentation" is on the prior content. Other than that, I suppose you could use Webmaster tools to see when and how much Google is indexing the site.

When I search for "Slicer documentation" I get https://www.slicer.org/wiki/Documentation as the 0000001 result - so I guess we're doing something right.

jcfr

jcfr

2017-06-07 13:23

administrator   ~0014537

Last edited: 2017-06-07 13:48

View 5 revisions

I looked at how readthedocs was dealing with this and they make use of canonical urls

http://docs.readthedocs.io/en/latest/canonical.html
https://moz.com/blog/how-to-advanced-relcanonical-http-headers
https://en.wikipedia.org/wiki/Canonical_link_element

For any given page https://www.slicer.org/wiki/Documentation/X.Y/subpage[/subpage[...]] If we could automatically include the following either

  • as link directly into the html
<link rel="canonical" href="https://www.slicer.org/wiki/Documentation/Latest/subpage[/subpage[...]]" />
  • or as a response header.

I think we should be all set

Also to implement the Latest two approaches:

  1. rewrite url on the web server
  2. explicit page creation on the wiki

I think (1) would be easier, this also mean that at each release of Slicer we would have to make sure to update the rewrite rules.

Thinking more about it, updating Latest pages ensuring they redirect as expected directly on the wiki is also feasible.

Issue History

Date Modified Username Field Change
2012-05-01 14:50 jcfr New Issue
2012-05-01 14:50 jcfr Status new => assigned
2012-05-01 14:50 jcfr Assigned To => jcfr
2012-05-01 14:50 jcfr Assigned To jcfr => mhalle
2012-05-01 15:19 jcfr Note Added: 0004119
2012-05-01 19:53 mhalle Note Added: 0004120
2012-05-02 06:51 jcfr Assigned To mhalle => jcfr
2012-05-02 06:52 jcfr Note Added: 0004124
2012-05-03 14:11 jcfr Note Added: 0004156
2012-05-15 14:56 jcfr Category Slicer Wiki => Documentation & Wiki
2012-08-21 11:59 jcfr Target Version => Slicer 4.3.0
2013-06-14 19:31 jcfr Relationship added related to 0002887
2013-06-14 19:31 jcfr Relationship added related to 0002905
2013-06-14 19:32 jcfr Note Added: 0008774
2013-06-14 19:32 jcfr Status assigned => resolved
2013-06-14 19:32 jcfr Fixed in Version => Slicer 4.3.0
2013-06-14 19:32 jcfr Resolution open => fixed
2013-06-14 19:34 jcfr Note Added: 0008775
2014-03-06 04:56 jcfr Note Added: 0010795
2014-03-06 04:58 jcfr Status resolved => closed
2016-06-20 14:15 jcfr Category Core: Documentation & Wiki => Core: Documentation and Wiki
2016-08-09 11:01 jcfr Assigned To jcfr => grundlett
2016-08-09 11:01 jcfr Status closed => feedback
2017-06-07 08:40 grundlett Status feedback => closed
2017-06-07 08:40 grundlett Note Added: 0014528
2017-06-07 09:55 jcfr Note Added: 0014531
2017-06-07 10:43 grundlett Note Added: 0014532
2017-06-07 11:53 jcfr Note Added: 0014534
2017-06-07 12:52 grundlett Note Added: 0014535
2017-06-07 13:23 jcfr Note Added: 0014537
2017-06-07 13:24 jcfr Note Edited: 0014537 View Revisions
2017-06-07 13:26 jcfr Note Edited: 0014537 View Revisions
2017-06-07 13:48 jcfr Note Edited: 0014537 View Revisions
2017-06-07 13:48 jcfr Note Edited: 0014537 View Revisions