docs
docs copied to clipboard
'Attaching files' has missing important note
Code of Conduct
- [X] I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files
What part(s) of the article would you like to see updated?
At this moment there is a Warning with info, but there is not mentioned about that - even if user will Cancel own changes, will not create an issue and so on so on, but just drag&drop a file during issue's creation process, it will be still uploaded. It looks quite dangerous (taking into account possible mistakes).
Example: https://user-images.githubusercontent.com/18367606/187424575-d4a4e50d-7c57-40d6-ae40-1a29ba0868dd.png
Typical two ways for this:
- first one - if I drag & drop (so upload file process) I can edit or delete/remove this (mistake case) later
- second one - if I wanted to upload something and I will not to have an opportunity to delete it in easy way, I can see a confirmation window ("Are you sure?")
The user should be warned about that.
Additional information
It's a little bit similar with: https://github.com/community/community/discussions/28316
Here it's focus on missing note about this.
Best wishes,
Update from a maintainer
The feedback about the product UI itself has been passed back to the product team.
Content design plan to address this issue
The simplest way to make the current behavior more explicit is to update the warning as follows:
- Replace the initial words of the warning "If you attach" to "When you upload".
- At the end of the paragraph explaining how to attach a file to an issue etc., add a new sentence explaining that the attached file is uploaded to GitHub and the comment is updated to show the URL for the file.
Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.
@mbiesiad Thanks so much for opening an issue! I'll triage this for the team to take a look :eyes:
Hi @mbiesiad - thanks for flagging your concerns.
I agree that it would be helpful to update the article to mention the fact that the image is uploaded immediately, even if you ultimately decide not to add the comment, cancel the changes etc. I'll update the issue summary with a short content design plan that you, or someone else can follow to raise a pull request to update the article.
I also agree with you that this is valuable product feedback, as reported in https://github.com/orgs/community/discussions/28316. It's a pity that the discussion was opened as "general", I think it would be more visible to the relevant team if the discussion was updated to include an Issues label. I'll pass this feedback on.
Actually, on looking more into this, I think we'll need to consult with a subject matter expert to check how this works for GitHub Enterprise Server. Then we'll be able to suggest docs changes to make this article clearer.
Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert :eyes:
Hi @cmwilson21 and @felicitymay, my pleasure!
Many thanks for your opinion and comments here. Sure, if we will have an outlines, I can help with that changes. Let's keep in touch.
Best wishes,
@mbiesiad - I've discussed this with an internal team and passed on your feedback.
I've added a content design plan to the issue summary with some small changes to the article that should make the current behavior clearer to users.
Thanks for bringing this to our attention ✨
As it is labeled HELP WANTED, PR is in progress. Wait for it.
EDIT : Job done. See below.
Many thanks @CapitainFlam 💖
I'm reviewing your pull requests. When they are both merged, this issue will be closed automatically. 🚀