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

Remove privacy breaches from the HTML documentation #621

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

Conversation

asarhaddon
Copy link
Contributor

@asarhaddon asarhaddon commented Mar 19, 2023

Icons and screenshots should not inform distant websites each time an user reads readme.html.

The suggestions in this draft are independent and will probably be discussed separately, but they affect a single file so for a first review a single commit is convenient.

  • Documentation content changes

Each time a navigator renders the README html version, it sends a request to the sites providing images for example.

This patch removes fancy buttons and downloads the screenshots on-demand. For the screenshots, another option is to store them in the VCS.

Does this introduce a breaking change?

  • No

Icons and screenshots should not inform distant websites each time an
user reads readme.html.

The suggestions in this draft are independent and will probably be
discussed separately, but they affect a single file so for a first
review a single commit is convenient.
@asarhaddon asarhaddon requested a review from zarath as a code owner March 19, 2023 15:24
@github-actions
Copy link

There hasn't been any activity on this pull request recently, and in order to prioritize active work, it has been marked as stale.
This PR will be closed and locked in 7 days if no further activity occurs.
Thank you for your contributions!

@github-actions github-actions bot added the stale Long time no reaction, will be closed soon label Jun 18, 2023
@asarhaddon
Copy link
Contributor Author

Hello.
This issue is not urgent, and you may eventually decide that it is not worth fixing. But it would be disappointing that a robot closes it only because it is not discussed fast enough.

@github-actions github-actions bot removed the stale Long time no reaction, will be closed soon label Jun 20, 2023
@t52ta6ek
Copy link
Contributor

t52ta6ek commented Jul 9, 2023

Maybe an easier way to solve this, rather than require a user explicitly click a link to pull up the image on imgur.com, is simply to embed the image using github's native cabability to do that itself. Example: https://github.com/t52ta6ek/APRS-SmartBeaconing-Worksheet . The screenshot of the worksheet is embedded in the README.md . That should address privacy concerns since the image is maintained at github (assuming https://user-images.githubusercontent.com is still github - LOL) and retains the original look and feel of the current README.rst implementation.

@asarhaddon
Copy link
Contributor Author

The (minor) issue is that a distant site is informed whenever someone reads the documentation, even a preformatted documentation on a local computer. That the distant site is imgur, github or githubusercontent.com is irrelevant here.
That said, the authors may be interested in your suggestion for other reasons.

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.

2 participants