Skip to content

Please document filtering repositories #16782

@jsoref

Description

@jsoref

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/repositories

What part(s) of the article would you like to see updated?

Afaict, nothing in this tree talks about filtering repositories.

https://docs.github.com/en/repositories?query=filter+repositories

image

image

image

Additional information

Note that there is documentation for filtering other objects.

https://github.com/orgs/github/repositories has a bunch of repositories:
image
And a type widget:
image

With

Select type

✔️ All
. Public
. Private
. Sources
. Forks
. Archived
. Mirrors
. Templates

Public is interesting and doesn't really do what I was expecting.
https://github.com/orgs/docs/repositories?q=&type=public&language=&sort=
(It basically shows any repository that isn't private)
The item could include a link to explain public and private and include links for converting a repository from public to private

Private more or less did what I was expecting, but it wasn't obvious that such a thing even existed (since I started by looking at an org that I wasn't a member of).
As w/ Public, it'd be nice if the docs explained public/private and included links for converting (the other way...)

Archive is interesting
https://github.com/orgs/docs/repositories?q=&type=archived&language=&sort=
It might even do what someone expects -- for the curious, it will list both public and private repositories if one is a member of the org and can thus see private archived repositories.
Similar to mirrors below, it could include a link to the docs for archiving a repository.

Mirrors -- I'm not sure what this does. I mean, I could guess what it should do, but I can't find any repository that actually matches this filter, so I'd love a definition to explain. And it'd be nice if it could then link to something that would explain how to mark a repository as a mirror.

Forks more or less did what I expected. I think. But, I could be wrong about what it's doing and what it does. So, documentation to explain what it does could be valuable.

Templates
I'm not going to guess how this behaves. I'd rather read the docs.

Sources doesn't do what I expected. And the name isn't intuitive.
Specifically, if a repository is the root of a fork tree and is archived, it doesn't show up when filtering for sources even though per the documentation, one can still fork it. This surprising behavior at the very least should be documented.

Lastly, once you have a page that documents what these filters do, you could include an explanation of how to filter for things people might want.

I want all non-archived repositories.

Here's a simple org for which this task is not simple:
https://github.com/docs

Metadata

Metadata

Assignees

No one assigned

    Labels

    engineeringWill involve Docs Engineeringwaiting for reviewIssue/PR is waiting for a writer's review

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions