Project

General

Profile

Todo #10135

help.php: Update links to use The pfSense Book

Added by Jim Pingle about 2 months ago. Updated about 2 months ago.

Status:
In Progress
Priority:
Normal
Assignee:
Category:
Web Interface
Target version:
Start date:
12/30/2019
Due date:
% Done:

30%

Estimated time:

Description

Most of the page-specific links in source:src/usr/local/www/help.php point to the old wiki documentation and not the book. Now that the book is public, these links should be updated where possible.

This replaces #10011 - #10133 so that we do not have to update so many Redmine issues for single-line changes each.

Associated revisions

Revision ebed725a (diff)
Added by Jim Pingle about 2 months ago

Update help.php current post-redirect URLs. Issue #10135

URLs were still pointing at the retired docs server URLs, update to
current targets after redirecting.

Revision 21abbc87 (diff)
Added by Jim Pingle about 2 months ago

Update help.php current post-redirect URLs. Issue #10135

URLs were still pointing at the retired docs server URLs, update to
current targets after redirecting.

Revision 0fca685f (diff)
Added by Jim Pingle about 2 months ago

Another layer of help.php URL redirects. Issue #10135

Like an onion.

Also remove some non-existent pages.

Revision 3b7d8533 (diff)
Added by Jim Pingle about 2 months ago

Another layer of help.php URL redirects. Issue #10135

Like an onion.

Also remove some non-existent pages.

Revision eeae77c9 (diff)
Added by Jim Pingle about 2 months ago

help.php book URL updates. Issue #10135

Revision daa19dce (diff)
Added by Jim Pingle about 2 months ago

help.php book URL updates. Issue #10135

Revision 0e73ead7 (diff)
Added by Jim Pingle about 2 months ago

Add help for missing pages. Issue #10135

Revision b8e599fc (diff)
Added by Jim Pingle about 2 months ago

Add help for missing pages. Issue #10135

History

#1 Updated by Jim Pingle about 2 months ago

  • Status changed from New to In Progress
  • % Done changed from 0 to 30

The concerns raised in #10011 - #10133 should all be addressed now, though there are still >200 URLs that point to the non-book docs, and about half of those are packages.

A lot of those won't be able to be addressed until after work is done on the book to incorporate info from the other docs, so this can probably be closed out once the pages which are currently possible are done. No need to make issues to create pages that do not yet exist, that's all part of a much larger project that doesn't need individual issues.

Ideally, further changes should be made as a PR against https://github.com/pfsense/pfsense/blob/master/src/usr/local/www/help.php or at least made using a consistent format in a single file which can be used to automate the update process.

#2 Updated by Jim Pingle about 2 months ago

  • Target version changed from 2.4.5 to 2.5.0

Moving this to 2.5.0, it is nice to have but not a release blocker.

Also available in: Atom PDF