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

Support cookie consent for git repositories #4356

Closed
4 tasks done
fwendland opened this issue Sep 14, 2022 · 3 comments
Closed
4 tasks done

Support cookie consent for git repositories #4356

fwendland opened this issue Sep 14, 2022 · 3 comments
Labels
change request Issue requests a new feature or improvement resolved Issue is resolved, yet unreleased if open

Comments

@fwendland
Copy link

Contribution guidelines

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

@squidfunk squidfunk added the change request Issue requests a new feature or improvement label Sep 14, 2022
@squidfunk
Copy link
Owner

Fixed in 6b1ce14

@squidfunk squidfunk added the resolved Issue is resolved, yet unreleased if open label Sep 18, 2022
@squidfunk
Copy link
Owner

Released as part of 8.5.2.

@fwendland
Copy link
Author

Thanks a lot for the great work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
change request Issue requests a new feature or improvement resolved Issue is resolved, yet unreleased if open
Projects
None yet
Development

No branches or pull requests

2 participants