Support cookie consent for git repositories #4356
Description
Contribution guidelines
- I've read the contribution guidelines and wholeheartedly agree
I want to suggest an idea and checked that ...
- ... to my best knowledge, my idea wouldn't break something for other users
- ... the documentation does not mention anything about my idea
- ... there are no open or closed issues that are related to my idea
Description
Users can provide a git repository by setting repo_url in mkdocs.yml. This will render a link to the repository on the website. Additionally, information, like stars, forks and latest release, are retrieved and rendered for public repositories hosted on GitHub or GitLab. These requests occur unconditionally and may violate data privacy regulations.
The retrieval of a repository's information should be configurable using:
- Option flag in
mkdocs.yml: It would disable the information retrieval all together. It is rather sever but has the benefit that there is no additional configuration necessary. On the downside, the provided repository information is nice for visitors. - Cookie consent: Visitors can decide whether they consent to the information retrieval. It would allow more flexibility and empower the visitor. On the downside, the solution may be more complex. and would require a cookie consent configuration in
mkdocs.yml.
See discussion #4329.
Use Cases
Would make the use of the git repository configuration more data privacy friendly. Developers can include the repository link without conflicting with privacy regulations.
Screenshots / Mockups
No response