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

New tasklists also allow shorthand syntax #26521

Merged
merged 3 commits into from
Jul 12, 2023

Conversation

HonkingGoose
Copy link
Contributor

@HonkingGoose HonkingGoose commented Jul 5, 2023

Why:

@omerbensaadon is a PM with GitHub, they said that the new tasklist feature also accepts #45 shorthand-syntax. The current docs say you must use the full URL like this: https://github.com/octo-org/octo-repo/issues/45

Fixes a part of issue #24862. It should not close the issue as more work is needed after my PR gets merged. 😉

What's being changed (if available, include any code snippets, screenshots, or gifs):

Rewrite a list item to allow both full URL and shorthand syntax, with examples of both.

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jul 5, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jul 5, 2023

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
issues/tracking-your-work-with-issues/about-tasklists.md fpt
ghec
fpt
ghec

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@cmwilson21
Copy link
Contributor

👋 Hey @HonkingGoose - great to have another contribution from you 🎉

I'll get this triaged for review! ⚡

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review issues Content related to issues and removed triage Do not begin working on this issue until triaged by the team labels Jul 6, 2023
@HonkingGoose
Copy link
Contributor Author

While you guys are triaging my change, also check if other parts of the document need to be changed as well. For example there's an example that only shows the full URL, and no shorthand-syntax:

Your finished tasklist should look like this:

```[tasklist]
### My tasks
- [ ] https://github.com/octo-org/octo-repo/issues/45
- [ ] Draft issue title
```

I could add a line like this to the [tasklist] above, to explain that shorthand-syntax is also allowed:

- [ ] #45 Shorthand-syntax is also allowed

Also I don't know if shorthand-syntax is the correct term for the "short URLs". 😄

@omerbensaadon
Copy link
Contributor

Thank you for your contribution @HonkingGoose

Copy link
Contributor

@guntrip guntrip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for adding this, @HonkingGoose! I'll get this merged shortly and make sure we include this in future iterations of these docs.

@guntrip guntrip added ready to merge This pull request is ready to merge and removed waiting for review Issue/PR is waiting for a writer's review labels Jul 10, 2023
@@ -45,7 +45,7 @@ You can create a tasklist using Markdown in the issue description (the opening c
1. To begin your tasklist, type <code>```[tasklist]</code> (triple backticks and <code>tasklist</code> inside square brackets) on a new line in the issue description.
1. Optionally, type `### TITLE` on the next line, replacing `TITLE` with a title for your tasklist.
1. For each item you want to add to your tasklist, type `- [ ]` on a new line, followed by a space, and either a link to an issue, a link to a pull request, or some text to create a draft issue.
- You must provide a full link to an issue or pull request. For example, `https://github.com/octo-org/octo-repo/issues/45`.
- You may provide a full link to an issue or pull request or, if the issue or pull request is in the same repository as your tasklist, you can use the #ISSUE-NUMBER shorthand syntax. For example, `https://github.com/octo-org/octo-repo/issues/45` or `#45`.
- Tasks can be formatted with Markdown.
- Tasks must not exceed 256 characters in length.
1. To finish your tasklist, type <code>```</code> on a new line after the last item.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stevecat before you merge, did you check if you want to update the [tasklist] example on line 55 through 61? Maybe that example should also show the shorthand-syntax?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@HonkingGoose Thanks for the reminder! ✨ I think we'll keep this as the optional step in the procedural for now. I think the example is super clear at the moment.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's okay! Thanks for merging my contribution! 😄

@guntrip guntrip added this pull request to the merge queue Jul 12, 2023
Merged via the queue into github:main with commit b128431 Jul 12, 2023
@github-actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

@HonkingGoose HonkingGoose deleted the docs/shorthand-syntax-new-tasklists branch July 12, 2023 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team issues Content related to issues ready to merge This pull request is ready to merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants