Project

General

Profile

Actions

Bug #19201

closed

[documentation] when viewing old versions, warn the user

Added by Ward Vandewege almost 2 years ago. Updated over 1 year ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
-
Target version:
Story points:
-
Release relationship:
Auto
Actions #1

Updated by Ward Vandewege almost 2 years ago

  • Status changed from New to In Progress
Actions #2

Updated by Ward Vandewege almost 2 years ago

ready for review at 1133c17437e018884fc32c554844e1c7dda76b27 on branch 19201-doc-warning-old-version

This assumes an update to the Apache config like this:

  <DirectoryMatch "/var/www/doc.arvados.org/(?<version>v[0-9]+\.[0-9]+)/">
    <If "file('/var/www/doc.arvados.org/latest') != %{env:MATCH_VERSION}" >
      AddOutputFilter Sed html
      OutputSed "s/style=\"display: none;\" id=\"old-version-warning/style=\"display: initial;\" id=\"old-version-warning/g" 
    </If>
  </DirectoryMatch>

and also that the /usr/local/bin/update-doc.arvados.org.sh script populates /var/www/doc.arvados.org/latest. These changes have already been made on the public server.

I also described the setup at https://dev.arvados.org/projects/ops/wiki/Docarvadosorg

Actions #3

Updated by Tom Clegg almost 2 years ago

LGTM -- suggestion, add a liquid comment that you shouldn't touch the opening div tag without checking the Apache OutputSed magic at https://dev.arvados.org/projects/ops/wiki/Docarvadosorg

Actions #4

Updated by Ward Vandewege almost 2 years ago

  • % Done changed from 0 to 100
  • Status changed from In Progress to Resolved

Applied in changeset arvados-private:commit:arvados|43963b16c532c1dfc473be136a1f03c633308100.

Actions #5

Updated by Ward Vandewege almost 2 years ago

Tom Clegg wrote in #note-3:

LGTM -- suggestion, add a liquid comment that you shouldn't touch the opening div tag without checking the Apache OutputSed magic at https://dev.arvados.org/projects/ops/wiki/Docarvadosorg

Thanks, applied with that change!

Actions #6

Updated by Peter Amstutz over 1 year ago

  • Release set to 47
Actions

Also available in: Atom PDF