Skip to content

Point links at OpenVoxProject repos where an equivalent exists, and fix a stale master branch reference #412

Description

@miharp

Summary

Some pages link to github.com/puppetlabs/* repositories that OpenVoxProject now maintains its own copy of, and one link to an OpenVoxProject repo uses a branch that no longer exists. Found while adding lang_data_uri (#411), which originally cited the specification at puppetlabs/puppet-specifications.

1. Branch reference that only works by redirect

OpenVoxProject/puppet-specifications has no master branch — its default is main, and it is a detached repo rather than a GitHub fork.

  • docs/_openvox-server_8x/puppet-api/v3/compile.markdown:6/blob/master/language/data-types/pcore-generic-data.md returns 302. Should be /blob/main/.

OpenVoxProject/openvox also defaults to main, so any /blob/master/ link to it has the same issue.

2. Links with an OpenVoxProject equivalent

Each target below was checked to exist in the OpenVoxProject org:

File Currently links to OpenVox equivalent
_openvox_8x/lang_expressions.markdown:26 puppetlabs/puppet-specifications OpenVoxProject/puppet-specifications
_openvoxdb_8x/api/query/v4/query.markdown:103 puppetlabs/puppet-specifications/blob/master/... same repo, /blob/main/
_openvox_8x/provider_development.markdown puppetlabs/puppet/blob/master/lib/puppet/feature/libuser.rb OpenVoxProject/openvox/blob/main/... (path confirmed present)
_openvox_8x/config_file_auth.markdown puppetlabs/puppet/blob/4.3.0/conf/auth.conf OpenVoxProject/openvox carries the full history, including tag 4.3.0
_openvox_8x/yard/index.md puppetlabs/puppet OpenVoxProject/openvox
_ecosystem_8x/devkit/jig.md (x2) puppetlabs/puppet-resource_api OpenVoxProject/puppet-resource_api
_openvoxdb_8x/pdb_support_guide.markdown puppetlabs/stockpile OpenVoxProject/stockpile
_openvoxdb_8x/release_notes.markdown puppetlabs/trapperkeeper/wiki/... OpenVoxProject/trapperkeeper (wiki may not be mirrored, needs checking)

Two judgement calls for whoever picks this up:

  • release_notes.markdown is a historical record. Rewriting links inside past release notes may be undesirable even when an equivalent exists.
  • config_file_auth.markdown pins tag 4.3.0 deliberately. The tag does exist in OpenVoxProject/openvox, so the switch is safe, but the intent is to show historical content and that should be preserved.

Explicitly out of scope

  • The 24 puppetlabs/bolt links are all in _openbolt_5x, which is generated from the upstream openbolt repo. Editing them here would be overwritten on the next regeneration; the fix belongs upstream. See docs: fix broken internal links in the openbolt collection #289 for the related openbolt link work.
  • Links to projects with no OpenVoxProject equivalent should stay as they are: rspec-puppet, r10k, puppet-lint, puppetlabs_spec_helper, control-repo, docs-archive, and the Forge modules (puppetlabs-stdlib, puppetlabs-ntp, puppetlabs-mysql, and so on).

How this was checked

# every puppetlabs repo linked from docs/
grep -rhoE 'https://github\.com/puppetlabs/[A-Za-z0-9._-]+' docs/ | sed 's|.*/||' | sort | uniq -c | sort -rn

# compare against the OpenVoxProject org
gh api /orgs/OpenVoxProject/repos --paginate -q '.[].name' | sort

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions