Skip to content

Conversation

@bertheyman
Copy link
Contributor

@bertheyman bertheyman commented Aug 21, 2023

Why:

The default pagination setting of 30 when downloading student repositories causes confusion for users.
I couldn't find this in the docs yet, so this PR guides users to use the --per-page flag.

Closes: github/gh-classroom#4

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

An extra line in the docs informing about the --per-page flag when downloading student repositories.

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.

The default setting of 30 causes confusion for users, as per issue github/gh-classroom#4.
@welcome
Copy link

welcome bot commented Aug 21, 2023

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

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

github-actions bot commented Aug 21, 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
education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli.md fpt
fpt

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

@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 education Content related to GitHub Education and removed triage Do not begin working on this issue until triaged by the team labels Aug 21, 2023
@cmwilson21
Copy link
Contributor

@bertheyman Thanks so much for submitting a PR! I'll get this triaged for review ⚡

@sophietheking sophietheking self-requested a review August 24, 2023 13:06
Copy link
Contributor

@sophietheking sophietheking left a comment

Choose a reason for hiding this comment

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

@bertheyman 👋 Thanks for opening this PR and contributing to our Docs, we really appreciate it!

This change looks good to me, so I'll get it merged. 🚀

@sophietheking sophietheking 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 Aug 24, 2023
@sophietheking sophietheking added this pull request to the merge queue Aug 24, 2023
Merged via the queue into github:main with commit 8524570 Aug 24, 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

@bertheyman bertheyman deleted the cli-docs-page-argument branch August 24, 2023 15:13
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 education Content related to GitHub Education ready to merge This pull request is ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature request: indicate that more pages exist in clone student-repos

3 participants