Page MenuHome Accel-ppp
Create Task
Maniphest T14

man file is outdated
Open, LowPublicBUG
Actions

Description

There are two sources of accel-pp documentation:

  1. man file (accel-ppp.conf.5)
  2. documentaion repo (accel-ppp-docs) (rst format)

accel-ppp.conf.5 file is outdated but still comes with the source code. This situation confuses people because most people don't know about the second one.

I suggest several ways how to manage this issue:

  1. Put the link to accel-ppp-docs website (https://accel-ppp.readthedocs.io/ ) to accel-ppp.conf.5 and remove everything else. I think it's not the best way because reathedocs.io might be down or blocked by china/russian/etc goverments.
  2. Generate man file from accel-ppp-docs repo using rst-to-man converters. That would be perfect
  3. Put the link to accel-ppp-docs website (https://accel-ppp.readthedocs.io/ ) to accel-ppp.conf.5 and add a warning regarding outdated content in the man file.

Details

Protocol
General
Version
all

Event Timeline

svlobanov triaged this task as Low priority.Apr 21 2020, 19:59
svlobanov created this task.
Dimka88 added a subscriber: Dimka88.Apr 22 2020, 13:03

I propose update accel-ppp.conf.5 for the actual state if something is missing
About https://accel-ppp.readthedocs.io/, we can also migrate this to the self-hosted side when appears some access issues.
Main goal docs on readthedocs.io to provide guides and detailed instruction instead of accel-ppp.conf.5