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.

Sign up for GitHub

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

Jump to bottom

Improve documentation for project board keyboard shortcut #1034

Closed
megbird opened this issue Nov 3, 2020 · 14 comments
Closed

Improve documentation for project board keyboard shortcut #1034

megbird opened this issue Nov 3, 2020 · 14 comments
Labels
good first issue Good for newcomers help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@megbird
Copy link
Contributor

megbird commented Nov 3, 2020

From @OKiMaureen:

What feature or product is affected?

Improve documentation for project board keyboard shortcut

https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/keyboard-shortcuts#project-boards

What is the new or expected behavior?

The user said:

I would suggest improving the keyboard shortcut documentation for project boards to be more clear about using enter to begin the process of moving cards.

This can be done by adding a separate description at the top that one needs to enter moving mode first.

Reason being that usually, keyboard shortcuts that are in a list like that don't depend on one another, Which is why I merely scanned the list for "move card to the top" and didn't think that any of the other entries in the list would be relevant.

How is the old or inaccurate behavior currently documented?

The Keyboard shortcuts for project boards are in a list which doesn't insinuate that the shortcuts depend on one another.

Who does this affect?

Users who make use of project board keyboard shortcuts

What is the impact to users?

Confusion.

Additional information

Example user from zendesk :

According to the docs, you'll have to first press enter to begin the process of moving a card. After that ↑ moves it up one step & control ↑ moves it to the top of the column. To finish the move press enter again.

I would suggest to improve the keyboard shortcut modal to be more clear about that though.
Such as adding a separate description at the top that one needs to enter moving mode first.
Reason being that usually, keyboard shortcuts that are in a list like that don't depend on one another. Which is why I merely scanned the list for "move card to the top" and didn't think that any of the other entries in the list would be relevant.
@megbird megbird added good first issue Good for newcomers triage Do not begin working on this issue until triaged by the team labels Nov 3, 2020
@Disneimabong

This comment has been minimized.

Sign in to view
@janiceilene janiceilene removed the triage Do not begin working on this issue until triaged by the team label Nov 4, 2020
@StarTrooper08
Copy link
Contributor

StarTrooper08 commented Nov 5, 2020 •
edited
Loading

Hello @megbird , I have an idea to fix this issue #1034 . If we add a popup which will contain gif and gif popup related to respective shortcut key will get activated when user will hover the shortcut keys image or text . That would surely help beginners to remember the shortcut keys .I m figuring out how this idea can be implemented since I m beginner in contribution .Please help me in fixing this doc .
Contrighdoc

This is an one sample of popup

Thank you

@megbird
Copy link
Contributor Author

megbird commented Nov 5, 2020

👋 @StarTrooper08 I love the idea and the image ⚡ we are currently constrained to only fixing the article's content, not including any design or CSS improvements. If you'd like to contribute a more scoped edit to "Project boards" section of Keyboard shortcuts article, that would be a PR we could accept 😄

For each row where it's applicable, we can make the shortcut clearer by saying:

"enter, then ↑ or k

and other similar edits wherever applicable in thatt section of the article. Let me know if you have any questions!

@StarTrooper08
Copy link
Contributor

Ya surely like to contribute to Github docs . But I m new to contribution process , please guide me in the process . I will surely fix the issue #1034 .Thank you .

@StarTrooper08
Copy link
Contributor

StarTrooper08 commented Nov 10, 2020 •
edited
Loading

@megbird how can I edit the keyboard shortcut part .
Please help me since I m a beginner contributer😅.

@janiceilene
Copy link
Contributor

👋 @StarTrooper08 Take a look at the contributing.md, then feel free to open a discussion if you have any additional questions 💛

StarTrooper08 added a commit to StarTrooper08/docs that referenced this issue Nov 10, 2020
@StarTrooper08
Improve documentation issue no github#1034
1fc2f0c 
Done with the minor fixes for open issue number github#1034 .
@StarTrooper08 StarTrooper08 mentioned this issue Nov 10, 2020
Merged
4 tasks
@StarTrooper08
Copy link
Contributor

@megbird @janiceilene I have done the changes in the keyboard shortcut section . Please have a glance whether I have done it properly or not .

@himanshu211raj
Copy link

How can i contribute to this issue? Can anyone here to help me to understand it properly?

@Disneimabong

This comment has been minimized.

Sign in to view
@janiceilene
Copy link
Contributor

@himanshu211raj There is a pull request waiting for review already. There are other available issues with the help wanted label ⚡

megbird added a commit that referenced this issue Dec 2, 2020
@megbird
Merge pull request #1242 from StarTrooper08/patch-1
af12121 
Improve documentation issue no #1034
Octomerger added a commit that referenced this issue Dec 2, 2020
@Octomerger @StarTrooper08
@Aakarsh-B @ariG23498 @macedogm @stephenwade @hongshaoyang @a2br @cassshh @nschonni @AntoineRondelet @shati-patel @megbird @wonda-tea-coffee @hubwriter @idpbond @felicitymay @JasonEtco
repo sync (#16715)
87fb2ce 
* Improve documentation issue no #1034

Done with the minor fixes for open issue number #1034 .

* Increasing the importance

I wanted to delete a branch, but I couldn't in spite of reading this document. The problem was, the branch I wanted to delete was the default branch. 
Even though it is stated in this document, it was not given enough importance that everyone would see it.

* typo

A small type in the comments

* Update setting-up-your-development-environment-to-create-a-github-app.md

Fix two small typos.

* properly capitalize "macOS"

* Clarify GH password requirements

* Change " to `

As done in the description of `master`

* " to ` in DE

* " to ` in PT

* " to ` in RU

* Fix typo metadata-syntax-for-github-actions.md

Fix typo for metadata-syntax-for-github-actions#outputs-for-composite-run-steps-actions

* chore: Remove bolding from headings

* Removed deprecated echo set-env instruction

* fix typo (#1516)

Co-authored-by: hubwriter <hubwriter@github.com>

* Remove extraneous grammar period which breaks the compare URL (#1252)

* Remove extraneous grammar period which breaks the compare URL

* Update data/reusables/repositories/two-dot-diff-comparison-example-urls.md

Co-authored-by: Nick Schonning <nschonni@gmail.com>

Co-authored-by: Nick Schonning <nschonni@gmail.com>
Co-authored-by: hubwriter <hubwriter@github.com>

* Revert "" to ` in RU"

This reverts commit d484fd6.

* Revert "" to ` in PT"

This reverts commit fab62f0.

* Revert "" to ` in DE"

This reverts commit 78abcd6.

* Change md

This squashes all the translation commits and their deletion.

* Update content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md

Co-authored-by: Felicity Chapman <felicitymay@github.com>

Co-authored-by: Atharva Shirdhankar <72031540+StarTrooper08@users.noreply.github.com>
Co-authored-by: Aakarsh B <aakarshbiju@gmail.com>
Co-authored-by: Aritra Roy Gosthipaty <aritra.born2fly@gmail.com>
Co-authored-by: Guilherme Macedo <guilherme@gmacedo.com>
Co-authored-by: Stephen Wade <stephen@stephenwade.me>
Co-authored-by: Shao Yang Hong <hongsy2006@gmail.com>
Co-authored-by: a2br <62328077+a2br@users.noreply.github.com>
Co-authored-by: Cas van Dinter <casvd@hotmail.com>
Co-authored-by: Nick Schonning <nschonni@gmail.com>
Co-authored-by: Antoine Rondelet <rondelet.antoine@gmail.com>
Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
Co-authored-by: Meg Bird <megbird@github.com>
Co-authored-by: ねず <39144575+wonda-tea-coffee@users.noreply.github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
Co-authored-by: Ilia <ilia@wearebond.com>
Co-authored-by: a2br <a2br@users.noreply.github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
Co-authored-by: Jason Etcovitch <jasonetco@github.com>
@janiceilene janiceilene added the help wanted Anyone is welcome to open a pull request to fix this issue label Dec 4, 2020
@Disneimabong

This comment has been minimized.

Sign in to view
@Disneimabong

This comment has been minimized.

Sign in to view
@cadamini
Copy link
Contributor

cadamini commented Mar 3, 2021 •
edited
Loading

Cool, didn't know about the shortcuts, will use them tomorrow ❤️
Why is the issue still open? I have seen #1242 has been merged. Anything we can do?

@janiceilene
Copy link
Contributor

Ooh, thanks for calling that out @cadamini! It looks like the PR wasn't linked with this issue, so it wasn't automatically closed.

jnidzwetzki pushed a commit to jnidzwetzki/docs that referenced this issue Oct 6, 2022
@charislam
Remove outdated info about commercial license (github#1034)
9b17978
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers help wanted Anyone is welcome to open a pull request to fix this issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@cadamini @megbird @janiceilene @himanshu211raj @StarTrooper08 @Disneimabong