Skip to content

Broken links to several vmware.com docs need to be replaced with their new Broadcom or VMware subdomain locations #405

@ScriptAutomate

Description

@ScriptAutomate

An issue was discovered in:

Several links that require updates, based on the CI/CD log output, because of the Broadcom acquisition of VMware resulting in lots of documentation links that are no longer valid:

http://pubs.vmware.com/vsphere-50/index.jsp?topic=%2Fcom.vmware.wssdk.pg.doc_50%2FPG_Ch5_PropertyCollector.7.6.html
https://code.vmware.com/apis/1163/nsx-t
https://developer.vmware.com/apis/csp/csp-iam/latest/csp/gateway/am/api/orgs/orgId/invitations/post/
https://developer.vmware.com/apis/csp/csp-iam/latest/csp/gateway/am/api/v2/orgs/orgId/users/delete/
https://developer.vmware.com/apis/csp/csp-iam/latest/csp/gateway/am/api/orgs/orgId/users/search/get/
https://developer.vmware.com/apis/csp/csp-iam/latest/csp/gateway/am/api/v2/orgs/orgId/users/get/
https://developer.vmware.com/apis/nsx-vmc-policy/latest/policy/api/v1/infra/domains/domain-id/security-policies/security-policy-id/rules/rule-id/patch/
https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/api/vcenter/vm/get/
https://developer.vmware.com/apis/nsx-vmc-policy/latest/policy/api/v1/infra/domains/domain-id/security-policies/security-policy-id/rules/rule-id/put/
https://developer.vmware.com/apis/vmc/v1.1/data-structures/MsftLicensingConfig/
https://developer.vmware.com/docs/nsx-vmc-policy/latest/data-structures/InlinePolicyNatRule1/
https://developer.vmware.com/docs/nsx-vmc-policy/latest/policy/api/v1/infra/domains/domain-id/groups/group-id/patch/
https://developer.vmware.com/docs/vmc/latest/vmc/api/orgs/org/sddcs/post/
https://developer.vmware.com/docs/vmc/latest/vmc/api/orgs/org/sddcs/get/
https://developer.vmware.com/docs/nsx-vmc-policy/latest/policy/api/v1/infra/domains/domain-id/groups/group-id/put/
https://developer.vmware.com/docs/vmc/latest/vmc/api/orgs/org/sddcs/sddc/clusters/cluster/delete/
https://developer.vmware.com/docs/vmc/latest/vmc/api/orgs/org/sddcs/sddc/clusters/post/
https://developer.vmware.com/docs/vmc/latest/vmc/api/orgs/org/sddcs/sddc/esxs/post/
https://developer.vmware.com/docs/vmc/latest/vmc/api/orgs/org/sddcs/sddc/get/
https://developer.vmware.com/docs/vmc/latest/vmc/api/orgs/org/sddcs/sddc/delete/
https://developer.vmware.com/docs/vmc/latest/vmc/api/orgs/org/sddcs/sddc/patch/
https://developer.vmware.com/docs/vmc/latest/vmc/api/orgs/org/sddcs/sddc/primarycluster/get/

Currently, a workaround is in place to skip these broken links in docs/conf.py via the linkcheck_ignore list variable.

    linkcheck_ignore = [
        "https://docs.github.com/en/authentication/connecting-to-github-with-ssh",
        "http://pubs.vmware.com",
        "https://developer.vmware.com",
        "https://code.vmware.com"
    ]

This isn't ideal. In order to have proper documentation, the URLs within the code base should be updated in order to assist the contributors, maintainers, and users of this salt extension.


Can attempt to correct and test stuff locally via:

# Launch container from root of this repo
docker container run -v $(pwd):/root/salty --rm -it ubuntu:22.04 /bin/bash

# Run these commands in container
cd ~/salty
apt update && apt install python3-pip python3-venv python3-enchant -y
python3 -m venv .venv
source .venv/bin/activate
pip install -U pip nox
nox --force-color -e docs --install-only
nox --force-color -e docs

# Can now view errors, and can modify the links or the docs/conf.py to then
# re-verify

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