Skip to content

'Attaching files' has missing important note #20289

Closed
@mbiesiad

Description

@mbiesiad

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: community/community#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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    SME reviewedAn SME has reviewed this issue/PRcontentThis issue or pull request belongs to the Docs Content teamget startedContent related to "Getting Started" doc set

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions