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

[docs] Don't use third-party fonts from fonts.googleapis.com on ddev.readthedocs.io #4982

Closed
1 task done
gitressa opened this issue Jun 14, 2023 · 21 comments · Fixed by #6027
Closed
1 task done

[docs] Don't use third-party fonts from fonts.googleapis.com on ddev.readthedocs.io #4982

gitressa opened this issue Jun 14, 2023 · 21 comments · Fixed by #6027

Comments

@gitressa
Copy link
Contributor

gitressa commented Jun 14, 2023

Is there an existing issue for this?

  • I have searched the existing issues

Problem

Respecting user privacy have been getting a lot of well deserved attention during the last few years. It is recommended to not use third-party fonts, to respect user privacy, and not hand over personal data to third-parties.

Steps To Reproduce

  1. Visit https://ddev.readthedocs.io/
  2. Open uBlock Origin
  3. See that the third-party font provider fonts.googleapis.com is used

Solution

@gitressa gitressa changed the title Don't use fonts from fonts.googleapis.com Don't use third-party fonts from fonts.googleapis.com on ddev.readthedocs.io Jun 14, 2023
@rfay rfay transferred this issue from ddev/ddev Jun 14, 2023
@rfay
Copy link
Member

rfay commented Jun 14, 2023

Moved to ddev.com-front-end

@mattstein
Copy link
Sponsor Collaborator

@rfay I’m confused—why move this to the ddev.com project when it’s specifically about the docs?

@rfay
Copy link
Member

rfay commented Jun 14, 2023

Just pretty confused I guess! Not thinking. I'll move it back. But I have no idea how we'd be using fonts unless it's an artifact of readthedocs?

@rfay rfay transferred this issue from ddev/ddev.com Jun 14, 2023
@rfay
Copy link
Member

rfay commented Jun 14, 2023

@gitressa would you mind poking around to figure out how the fonts are being pulled in?

@gitressa
Copy link
Contributor Author

Sure @rfay, I found this:

squidfunk commented Nov 12, 2022

If you're a user of Material for MkDocs, enabling the built-in privacy plugin will automatically download and replace all external assets that are found in the resulting HTML with local versions. This means that mkdocs/mkdocs#2171 (comment) is also solved, since all external files found in the HTML are handled - no additional vendoring necessary.

This is the Material for MkDocs setting: Built-in privacy plugin.

I see mkdocs-material>=9 in https://github.com/alexbogias/ddev/blob/master/docs/mkdocs-pip-requirements, so maybe possible?

@rfay
Copy link
Member

rfay commented Jun 14, 2023

Want to try a PR?

@rfay rfay changed the title Don't use third-party fonts from fonts.googleapis.com on ddev.readthedocs.io [docs] Don't use third-party fonts from fonts.googleapis.com on ddev.readthedocs.io Jun 14, 2023
@gitressa
Copy link
Contributor Author

Great that you're open for this @rfay. I don't have time to look at it right now, but anyone else should feel free to create a PR in the meantime.

@rfay
Copy link
Member

rfay commented Jun 18, 2023

OK @gitressa please reopen when you have time to look into it, thanks!

@gitressa
Copy link
Contributor Author

I finally took stab at this @rfay. It ought to be as easy as adding two lines, which should install the privacy plug-in.

The privacy plugin is built into Material for MkDocs and doesn't need to be installed.

https://squidfunk.github.io/mkdocs-material/plugins/privacy/#configuration

The test fails, though:

ERROR   -  Config value 'plugins': The "privacy" plugin is not installed

Aborted with 1 configuration errors!i

But ... you need to be a sponsor for this feature: https://squidfunk.github.io/mkdocs-material/insiders/

It's the heart icon, right below the title, which I understood after I found this: squidfunk/mkdocs-material#5317 (comment)

@rfay
Copy link
Member

rfay commented Oct 26, 2023

Ah. We did sponsor and use the insiders version for a while, but it meant that ordinary users couldn't build the docs, so stopped, and went with the full open-source.

@rfay
Copy link
Member

rfay commented Oct 26, 2023

We'd be happy to sponsor, but can't use something that requires one person's ssh key to be able to do a build.

@gitressa
Copy link
Contributor Author

gitressa commented Oct 26, 2023

Thanks for clarifying @rfay. The next step in their fund raising is $14,000 – Goat's Horn where Privacy plugin will become available for everyone.

Current funding is close at $13,860 a month, so perhaps DDEV could consider becoming a sponsor again?

@rfay
Copy link
Member

rfay commented Oct 26, 2023

I need to review our upstream contributions, so will remember this. We can sponsor without using their too-hard-to-manage private build setup. Thanks!

@gitressa
Copy link
Contributor Author

Sounds great, funding open source projects is important, as we all know :-)

@rfay
Copy link
Member

rfay commented Oct 30, 2023

DDEV is once again a sponsor of mkdocs-material

image

@gitressa
Copy link
Contributor Author

Great, thanks @rfay! If the key thing is still a problem, and since I don't know the details, would you consider creating an issue about it at https://github.com/squidfunk/mkdocs-material/issues?

It might also help other projects to get this sorted out.

@rfay
Copy link
Member

rfay commented Oct 31, 2023

The issue was discussed in

@gitressa
Copy link
Contributor Author

Thanks, I have subscribed to that issue, and hope Insiders' workflow will be improved, or the goal of 14,000 reached, whatever comes first.

@gitressa
Copy link
Contributor Author

I just checked, and the current funding is $14,720 a month (congratulations!) which should mean that the Built-in privacy plugin is now available to be enabled.

... those features were part of Insiders, but are now generally available and can be used by all users.

https://squidfunk.github.io/mkdocs-material/insiders/#14000-goats-horn

@rfay
Copy link
Member

rfay commented Mar 28, 2024

A PR is welcome!

@rfay rfay reopened this Mar 28, 2024
@gitressa
Copy link
Contributor Author

gitressa commented Mar 28, 2024

Sure! It's here, and just need reopening: #5463.

rfay pushed a commit that referenced this issue Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants