SDP-668
Closed
Do you have a way to automate validation of http/https links in files when packaging up the SDP so broken links can be checked with each release?
I noticed in https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/doc/gen/mkrep.sh.man.txt the "Server Spec Naming Standard" and "Journal Prefix Standard" now result in 404 "page not found" errors. The new links seem to be https://swarm.workshop.perforce.com/projects/perforce-software-sdp/view/main/doc/SDP_Guide.Unix.html#_server_spec_naming_standard and https://swarm.workshop.perforce.com/projects/perforce-software-sdp/view/main/doc/SDP_Guide.Unix.html#_the_journalprefix_standard but are Unix specific. The Windows guide at https://swarm.workshop.perforce.com/projects/perforce-software-sdp/view/main/doc/SDP_Guide.Windows.html doesn't reference them.
There are 1800+ results in //guest/perforce_software/sdp/dev/doc/ for 'http' so it would be handy to have an automated checker to make sure they're all still valid each time the SDP is packaged up.
I noticed in https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/doc/gen/mkrep.sh.man.txt the "Server Spec Naming Standard" and "Journal Prefix Standard" now result in 404 "page not found" errors. The new links seem to be https://swarm.workshop.perforce.com/projects/perforce-software-sdp/view/main/doc/SDP_Guide.Unix.html#_server_spec_naming_standard and https://swarm.workshop.perforce.com/projects/perforce-software-sdp/view/main/doc/SDP_Guide.Unix.html#_the_journalprefix_standard but are Unix specific. The Windows guide at https://swarm.workshop.perforce.com/projects/perforce-software-sdp/view/main/doc/SDP_Guide.Windows.html doesn't reference them.
There are 1800+ results in //guest/perforce_software/sdp/dev/doc/ for 'http' so it would be handy to have an automated checker to make sure they're all still valid each time the SDP is packaged up.
- Status
- Closed
- Project
- perforce-software-sdp
- Severity
- C
- Reported By
- Domenic
- Reported Date
- 4 years ago
- Modified By
- C. Thomas Tyler
- Modified Date
- 4 years ago
- Owned By
- Domenic
- Component
- doc
- Type
- Feature
Good idea. We should have an automated checker for doc links.
The Journal Prefix and Server Spec Naming Standard were moved into the adoc, and the corresponding links were missed. Those were fixed just now.
Those references are in the mkrep.sh source code, which is embedded only into the UNIX/Linux guide doc. That script is currently only supported on the UNIX/Linux flavor of the SDP, hence the lack of reference the Windows SDP adoc file. If that script is ever made available on Windows, the links would be added then.