Project

General

Profile

Feature #46909

Replace doc.freenas.org with a Guide version menu selector

Added by Warren Block over 1 year ago. Updated over 1 year ago.

Status:
Done
Priority:
No priority
Assignee:
Václav Navrátil
Category:
Forums/Websites
Target version:
Estimated time:
Severity:
New
Reason for Closing:
Reason for Blocked:
Needs QA:
No
Needs Doc:
No
Needs Merging:
No
Needs Automation:
No
Support Suite Ticket:
n/a
Hardware Configuration:

Description

doc.freenas.org confusingly dumps the user into a list of versions of FreeNAS. Many users don't know which version they are running.

We need to change this so the current version of the User Guide is shown, with a way for the user to look for older versions if they need them.


Related issues

Related to FreeNAS - Umbrella #54909: Unhook Guide from build system and link to online versionDone

History

#1 Updated by Warren Block over 1 year ago

  • Status changed from Unscreened to In Progress

Added googlize script to post-process HTML files, including adding Google Analytics.

https://github.com/freenas/freenas-docs/commit/30c404e33721445d446cce6fe46c855e008d7bac#diff-03d4bfc5a33dfa5eb21d0ca3fc141d82

#2 Updated by Warren Block over 1 year ago

With help from Vaclav, add an epilog that provides a floating "Previous Versions" button.

https://github.com/freenas/freenas-docs/commit/a79dddf389042ed7dd68ca7fab525d8b1f87e7e0#diff-03d4bfc5a33dfa5eb21d0ca3fc141d82

#3 Updated by Warren Block over 1 year ago

  • Status changed from In Progress to Unscreened
  • Assignee changed from Warren Block to Václav Navrátil

Vaclav, can you change doc.freenas.org to go directly to the current User Guide?

When that is done, we can add the googlize script the the job that installs the guide on that webserver.

The googlize script can be run manually on the existing versions.

#4 Updated by Dru Lavigne over 1 year ago

Do we have a mechanism for the user to choose which Guide to read? At a minimum, we need a way for the user to choose between the 11.1-* and the 11.2-* versions of the Guide.

#6 Updated by Václav Navrátil over 1 year ago

  • Assignee changed from Václav Navrátil to Warren Block

Warren, do you have an idea, how we will keep the documentation always current? Will we symlink into the latest doc directory on the end of the build? Can you share your vision?

Unless you have a vision, feel free to let it up to me.

Dru, that sounds like a great idea. I'm all pro-integration.

#7 Updated by Warren Block over 1 year ago

  • Assignee changed from Warren Block to Václav Navrátil

I don't know how this has been done up until now. The web server has not been accessible by docs, so we have not been involved.

It would be preferable to have this done by the Jenkins doc install job so it is not manual, if that is possible.

#8 Updated by Václav Navrátil over 1 year ago

  • Assignee changed from Václav Navrátil to Dru Lavigne

Docs are changed. Redirection goes to the latest version and archive was enabled.
We have only minimal changes in the urls (index.html -> /11/ and new archive.html) so hopefully, we will not get much penalized by Google and we will not lose any backlinks.

What we need now is to change wording on archive and include 11.2

#9 Updated by Dru Lavigne over 1 year ago

  • Status changed from Unscreened to In Progress
  • Assignee changed from Dru Lavigne to Warren Block

#10 Updated by Dru Lavigne over 1 year ago

Notes that right now there is no way to get to 11.2 as button only covers "Previous Versions".

#11 Updated by Warren Block over 1 year ago

  • Assignee changed from Warren Block to Václav Navrátil

I have updated the googlize script (https://github.com/freenas/freenas-docs/blob/angulargui/userguide/googlize) to fix the button shadow color and changed the wording to Other Versions.

Please re-run this version on the existing HTML files to change those values.

#12 Updated by Václav Navrátil over 1 year ago

  • Assignee changed from Václav Navrátil to Warren Block

Docs are re-googlized.

#13 Updated by Dru Lavigne over 1 year ago

  • Target version changed from 11.2-RC1 to N/A

#14 Updated by Warren Block over 1 year ago

  • Needs QA changed from Yes to No
  • Needs Doc changed from Yes to No
  • Needs Merging changed from Yes to No

#15 Updated by Dru Lavigne over 1 year ago

  • Related to Umbrella #54909: Unhook Guide from build system and link to online version added

#16 Updated by Dru Lavigne over 1 year ago

  • Assignee changed from Warren Block to Václav Navrátil
  • Target version changed from N/A to 11.2-RC2

#18 Updated by Dru Lavigne over 1 year ago

  • Status changed from In Progress to Done

#20 Updated by Dru Lavigne over 1 year ago

  • Subject changed from Update doc.freenas.org to Replace doc.freenas.org with a Guide version menu selector

Also available in: Atom PDF