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

Github API deprecation doc uses githubuser-content image links #863

Closed
wolf99 opened this issue Sep 9, 2022 · 3 comments · Fixed by #894
Closed

Github API deprecation doc uses githubuser-content image links #863

wolf99 opened this issue Sep 9, 2022 · 3 comments · Fixed by #894
Labels
docs Documentation changes enhancement New feature or request

Comments

@wolf99
Copy link
Contributor

wolf99 commented Sep 9, 2022

Hi!

As you may know I've been working to tidy the markdown docs a little bit.
During #680 , I noticed that https://github.com/GitCredentialManager/git-credential-manager/blob/main/docs/github-apideprecation.md uses images linked from https://user-images.githubusercontent.com type URLs.

It may make more sense to have the images stored in the docs/img dir within the repo, as with images used in other doc files.
But I cannot tell from the URL where those images are currently actually stored so I am unsure if this is a good idea and where to go do correctly source the image files.

Do you know where those image files are? Another repo or GitHub help page maybe?
It looks like it may have been the latter at one point, but that the GitHub docs were then since changed...

Some examples of the image: URLs used:

@wolf99 wolf99 added the enhancement New feature or request label Sep 9, 2022
@Wmoow122

This comment has been minimized.

@Wmoow122

This comment has been minimized.

@ldennington
Copy link
Contributor

I think this is a good idea! My suggestion is to download the images at the links and add them to the img directory and change the links in the file.

@mjcheetham mjcheetham added the docs Documentation changes label Sep 19, 2022
wolf99 added a commit to wolf99/git-credential-manager that referenced this issue Oct 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation changes enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants