Skip to content

Remove ALL external dependencies for our docs site — EXPERIMENTAL, DO NOT MERGE #146

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

Closed
wants to merge 7 commits into from

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Nov 17, 2023

Internal Notes for Reviewers

This is an experimental what-if PR that removes ALL external dependencies for our docs site, including:

  • Locally stored Google fonts
  • Commented out Google Analytics
  • Encoded SVG logo for Python docs to replace reference to AWS S3 bucket
  • Locally stored template schema docs JavaScript files

Notes

  • The SVG changes are not permanent, as they would require a change to the Makefile for generating the Python docs in the develper-framework repo which does not currently seem supported.
  • The JavaScript changes break the template schema docs AND our search as they run afoul of Reason: CORS request not HTTP. To fix this, we would need to run a web server instead of providing a generated static site which is a deal breaker.

Will create another PR that includes only the safe changes that we can merge.

External Release Notes

@nrichers nrichers added documentation Improvements or additions to documentation DO NOT MERGE PR is not ready to be merged internal Not to be externalized in the release notes labels Nov 17, 2023
@nrichers nrichers closed this Nov 22, 2023
@nrichers nrichers deleted the remove-external-dependencies branch April 8, 2024 21:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DO NOT MERGE PR is not ready to be merged documentation Improvements or additions to documentation internal Not to be externalized in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant