docs
docs copied to clipboard
github
Improving content: Create a Windows Credential Manager documentation page
This issue is a partial breakdown from issue #429 (see this comment).
What article on docs.github.com is affected?
Currently there's a topic to help macOS users update their credentials: Updating credentials from the macOS Keychain . The sub-issue here is the need for a Windows Credential Manager documentation page to complement this content.
What part(s) of the article would you like to see updated?
This requires a new article.
Additional information
Attention required to any existing GitHub guidelines involving content for different Windows versions.
[maintainer edit] Anyone is welcome to open a PR documenting the information for Windows Credential Manager.
Hi @casals - I've taken the liberty of updating the issue description to include a little more of the information from the original issue - it just means that people can see what this is about at a glance.
The writers at GitHub always start a content plan by thinking about who we're writing for, what they need to know, and what questions they might have. Then we plan the content to address those needs. We work from a template that reminds us what we need to think about. I've included the simplified template that we've recently started using to write content plans for open source contributors below.
For this issue, the existing macOS topic is probably also a good resource for thinking about what needs to be in the new topic for Windows users, but there may be additional considerations for Windows users.
## Content plan
Summarize the issue, the impact on GitHub users, and the documentation changes we'll make to resolve the issue.
### Audience
Describe the audience for the change.
### Content to update
List the articles we'll update with relevant details on the change to make.
### Questions
If you have any questions after writing a plan, ask them here!
Just noting here for clarity that you or anyone else is welcome to create a PR to add new article in the same category, "Getting started with Git" with this information. Thanks again @casals!
Can I work on this too? I do need a headstart on what I should be doing.
👋 @ArkaprabhaChakraborty the first steps for this issue are described in https://github.com/github/docs/issues/698#issuecomment-714439503. You can use the template to create a content plan and drop it as a new comment in this issue 💖
I also just realized this was listed as a "good first issue" which isn't quite accurate, so I've removed that label 💛
This issue is a partial breakdown from issue #429 (see this comment).
What article on docs.github.com is affected?
Currently there's a topic to help macOS users update their credentials: Updating credentials from the macOS Keychain . The sub-issue here is the need for a Windows Credential Manager documentation page to complement this content.
What part(s) of the article would you like to see updated?
This requires a new article.
Additional information
Attention required to any existing GitHub guidelines involving content for different Windows versions.
[maintainer edit] Anyone is welcome to open a PR documenting the information for Windows Credential Manager.
Qut
Hi @janiceilene, Is this issue still open to contributions? If possible I'd like to work on it. ^-^
👋 @alexis-opolka - You, or anyone else, are welcome to work on this issue 💖
After having thought a bit about it, here is my proposition of a content plan:
Content plan
The issue is the lack of a documentation page on Windows Credential Manager while there's one for macOS, as pointed out by @casals.
I think it would be better to rename the updating-credentials-from-the-macos-keychain page to something more global such as updating-credentials-from-your-keychain with the new page including both Windows and macOS, even Linux if deemed appropriate.
Audience
The audience would be beginners with Git on one of the OS cited above learning on how to update their credentials.
Content to update
The updating-credentials-from-the-macos-keychain page should be updated with the choice of the OS like in adding-a-new-ssh-key-to-your-github-account.
The current content should be placed under the macOS part and new steps should be created for windows and/or Linux.
Questions
Will it be interesting to add some screenshots in both Windows and macOS sections as the audience, from what I understand, is beginners?
Please feel free to criticate my proposed content plan, I'd love to have any insightful feedback. ^-^
Hi @cmwilson21,
Sorry for the ping but I'd like to know if someone had the time to look a bit more into this issue and read the content plan I'm proposing as I'm waiting to work on it since the needs content strategy is still assigned to this issue.
Thanks in advance. ^-^
@alexis-opolka Sorry for the delay here! I'll take a look at it and get back to you in the next couple of days.
Thanks for your patience!
El dom, 13 de ago de 2023, 7:51 a. m., Alexis Opolka < @.***> escribió:
Hi @cmwilson21 https://github.com/cmwilson21👋🏼, Are there any news regarding this issue? ^-^
— Reply to this email directly, view it on GitHub https://github.com/github/docs/issues/698#issuecomment-1676381919, or unsubscribe https://github.com/notifications/unsubscribe-auth/A72X273GNFWJUR3PN7DDYL3XVDSX5ANCNFSM4S2EDYXA . You are receiving this because you are subscribed to this thread.Message ID: @.***>
@alexis-opolka I like the idea of consolidating the articles into one page and using something like our tool switcher to select the appropriate operating system. I hesitate with renaming it updating-credentials-from-your-keychain as the Windows version is Windows Credential Manager and doesn't use the word "keychain". So maybe even making it more generic like "Managing your credentials" makes it more flexible.
To add articles based on operating systems, check out our Markdown and Liquid guide section on operating system tags.
Here's more information about changing titles in the docs.
As for the screenshots, I would hesitate to add them here because it's my understanding that we are referring to personal operating system screenshots as opposed to GitHub interface screenshots. We have less control and knowledge of updates when regarding operating system UI. Although I really appreciate your consideration for our beginner users, I think leaving screenshots out of this one would be the right call. You can find more about our criteria for including screenshots here.
My apologies again for the delay, but I hope some of this information is helpful 💖
Hi @cmwilson21👋🏼,
Thank you for those precious links, I'll be sure to read them. 😄
I think "Managing your credentials" is the kind of title we need for this article because it will be generic enough to keep the users without much "technical" knowledge without losing the meaning of what the user is going to read on the page. 👍🏼
I think you're indeed right about including screenshots that are not relevant to a GitHub product, while it may help beginners to visually see what to do, if the screenshots are not up to date they may do the countrary and perturb the beginners or that would mean an increase in work load to make sure to be up to date with each UI elements of other products.
I think I'll be able to work on a draft during the weekend, just after I sent my applications for internships abroad, would it be ok for me to ping you then? ^-^
@alexis-opolka You are exactly right about screenshots being more of a burden and increase in work in some cases. 👍
I'll get a notification when your PR is opened in this repo, but you are welcome to ping me for visibility ✨
Hi @cmwilson21 and @alexis-opolka! I've been looking deeper into this issue, and I wonder whether or not a new article is needed to resolve this. Both Git Credential Manager (included with Git for Windows) and GitHub CLI store credentials in Windows Credential Manager. There's really no need for the user to update these credentials manually. Caching Your GitHub Credentials in Git covers both options and also addresses how to delete outdated credentials cached in WCM, should they cause conflicts.
If you agree that the linked article satisfies the primary concerns here, I would recommend that this issue be marked as closed. Thanks! 🙂
@mark-mxwl Thank you for raising this point! I am in agreement ✨ I'll go ahead and close this issue out, but we of course can reopen should a need arise in the future 💛
