Opened 4 years ago

Closed 4 years ago

#3621 closed change (rejected)

Redirect JSDoc URLs for the core code to their new location

Reported by: fhd Assignee: fhd
Priority: P2 Milestone:
Module: Infrastructure Keywords:
Cc: trev Blocked By: #1299, #2594, #3618, #3619, #3637
Blocking: #2595 Platform: Unknown / Cross platform
Ready: yes Confidential: no
Tester: Unknown Verified working: no
Review URL(s):

Description (last modified by fhd)

Background

#2594 moves the core code out of the adblockplus repository, while #3618 and #1299 will generate the JSDoc documentation for that code at a new location.

We are, however, linking to the docs of the core code in various places. We should keep the old URLs working, and redirect them to the new location.

What to change

Redirect the URLs for all core classes and globals from https://adblockplus.org/jsdoc/adblockplus/... to https://adblockplus.org/jsdoc/adblockpluscore/....

The files to redirect are:

ActiveFilter.html
BlockingFilter.html
CSSPropertyFilter.html
CSSRules.html
CombinedMatcher.html
CommentFilter.html
Downloadable.html
DownloadableSubscription.html
Downloader.html
ElemHide.html
ElemHideBase.html
ElemHideException.html
ElemHideFilter.html
ExternalSubscription.html
Filter.html
FilterListener.html
FilterNotifier.html
FilterStorage.html
HistoryPurgeObserver.html
INIParser.html
InvalidFilter.html
Matcher.html
Notification.html
RegExpFilter.html
RegularSubscription.html
SpecialSubscription.html
Subscription.html
Synchronizer.html
WhitelistFilter.html
cssRules.js.html
downloader.js.html
elemHide.js.html
filterClasses.js.html
filterListener.js.html
filterNotifier.js.html
filterStorage.js.html
matcher.js.html
notification.js.html
subscriptionClasses.js.html
synchronizer.js.html

Unfortunately, global symbols moved from the adblockplus to the adblockpluscore documentation cannot be redirected since they are all in globals.html.

Change History (12)

comment:1 Changed 4 years ago by fhd

  • Description modified (diff)
  • Summary changed from Redirect jsdoc URLs for the core code to their new location to Redirect JSDoc URLs for the core code to their new location

comment:2 Changed 4 years ago by fhd

  • Cc trev added

comment:3 Changed 4 years ago by fhd

  • Blocked By 1299 added

comment:4 Changed 4 years ago by fhd

  • Description modified (diff)

comment:5 Changed 4 years ago by fhd

  • Blocking 2595 added

comment:6 Changed 4 years ago by fhd

  • Owner set to fhd

comment:7 Changed 4 years ago by fhd

  • Description modified (diff)

comment:8 Changed 4 years ago by fhd

  • Description modified (diff)

comment:9 Changed 4 years ago by fhd

I just realised that we will also have to redirect all the stuff currently in symbols, presumably generated by an old version of JSDoc, and still being linked to, that is:

/symbols/_global_.html
/symbols/ActiveFilter.html
/symbols/AdblockPlus.html
/symbols/BlockingFilter.html
/symbols/Cache.html
/symbols/CombinedMatcher.html
/symbols/CommentFilter.html
/symbols/DownloadableSubscription.html
/symbols/ElemHideBase.html
/symbols/ElemHideException.html
/symbols/ElemHideFilter.html
/symbols/ExternalSubscription.html
/symbols/Filter.html
/symbols/HitRegistrationChannel.html
/symbols/INIParser.html
/symbols/InvalidFilter.html
/symbols/Matcher.html
/symbols/objTabs.html
/symbols/RegExpFilter.html
/symbols/RegularSubscription.html
/symbols/SpecialSubscription.html
/symbols/Subscription.html
/symbols/WhitelistFilter.html

And also, both for the old and the new version, we need to redirect the source file URLs, e.g. /symbols/src/_tmp_abpE63NFH_lib_filterNotifier.js.html.

Considering the extra effort involved, I'm starting to question whether it's worth it. We can (and should anyway) update all the links we have to that documentation on our websites etc. As for external links, it will be less convenient, but still possible to find what the user is looking for.

What do you think, Wladimir?

comment:10 Changed 4 years ago by fhd

  • Blocked By 3637 added

comment:11 Changed 4 years ago by trev

We never linked directly to any documentation, nor are these links really stable. For example, they will most likely change once we add @module to all the files. So - no, not really worth the effort I guess.

comment:12 Changed 4 years ago by fhd

  • Resolution set to rejected
  • Status changed from new to closed

We link to it in the libadblockplus documentation, but I guess you're right, the links aren't particularly stable anyway...

Note: See TracTickets for help on using tickets.