Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve orphaned-content and test suite #522

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ScriptAutomate
Copy link

@ScriptAutomate ScriptAutomate commented Feb 15, 2025

Summary

I don't know enough about the standards of this repo when it comes to expectations of what is considered orphaned content, so I made assumptions that I can correct based on PR review:

  • When should a file be in a TOC (always, or only sometimes?) - I assumed always
  • When should a file be using relative links (always, or sometimes?) - I assumed always
  • Are there certain TOC files we care about and not others (or do we care about all of them?) - I assumed we care about all of the TOCs
  • Are there certain files/dirs under ./src meant to be exempt from search, etc. - I assumed the TOC files themselves are not meant to be linked to from other files

As a result, I have the following test output for orphaned-content.py in the initial PR:

Found the following unlinked 7 file(s):
./src/deployment-guides/tap.md
./src/deployment-guides/tpsm-ag-on-vsphere-dep.md
./src/partials/README.md
./src/reference-designs/tap-on-tkgi.md
./src/reference-designs/tko-data-protection.md
./src/reference-designs/tko-on-azure-hybrid.md
./src/solution-workbooks/Deploy Multi-site Spring application using Tanzu Data on TAS.md
Found the following 15 file(s) missing from the TOC(s):
./src/deployment-guides/tap.md
./src/deployment-guides/tkg-package-install.md
./src/deployment-guides/tko-saas-services.md
./src/deployment-guides/tko-to-customized-dashboard.md
./src/deployment-guides/tpsm-ag-on-vsphere-dep.md
./src/partials/README.md
./src/partials/tkg-velero-vsphere-plugin.md
./src/partials/tmc-service-account-pods.md
./src/partials/troubleshoot-supervisor.md
./src/partials/vyatta.md
./src/reference-designs/tap-on-tkgi.md
./src/reference-designs/tko-data-protection.md
./src/reference-designs/tko-on-azure-hybrid.md
./src/reference-designs/tko-saas.md
./src/solution-workbooks/Deploy Multi-site Spring application using Tanzu Data on TAS.md

@ScriptAutomate ScriptAutomate marked this pull request as ready for review February 15, 2025 09:17
@ScriptAutomate ScriptAutomate requested review from a team as code owners February 15, 2025 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

orphaned-content check isn't discovering all orphaned files, including files that are missing from any TOCs
1 participant