Feature Request: Project Description

[jgarte]

Hi, what do you think of adding a short project description here:

[jaraco]

First, thanks for the suggestion.

The project does have a description (here and here). Unfortunately, GitHub doesn't automatically reflect that description, so we'd need to manually replicate it a third time. And although that would be a small change to add to this one project, it implies that it should be done across every project I maintain, and that I and other maintainers should spend energy keeping GitHub in sync with the code. If I were simply to add the description to this project, it would invite similar issues to hundreds of other projects, creating a lot of toil that I'd like to avoid.

Perhaps better would be for GitHub to hide the About section when nothing is populated there.

Another option could be to implement a routine that automatically syncs the project description (and other metadata) into GitHub and then to use tools like jaraco.develop to mechanically perform that sync across all projects periodically.

I'm currently working with @bswck to create an organization where cross-project issues like these can be addressed. I'll plan to move this issue to an umbrella project later.

In the meantime, I welcome your or others' ideas around how to manage metadata in GitHub.

[bswck]

I can add some gh CLI routine in jaraco.develop. @jaraco mind if I do it?

[jaraco]

Sure, give it a shot!

[jaraco]

I was thinking that passing the Project-URL to configure the URL, but then I realized that would typically link directly to the same page... so probably for the URL, we should generate the PyPI URL and use that as the URL (or maybe just ignore the URL for now).

[bswck]

I was thinking that passing the Project-URL to configure the URL, but then I realized that would typically link directly to the same page... so probably for the URL, we should generate the PyPI URL and use that as the URL (or maybe just ignore the URL for now).

In my opinion, the most pragmatic use of project URL would be a documentation URL. I will reference it in a separate roadmap issue in jaraco.develop that will close this.

[bswck]

I'll plan to move this issue to an umbrella project later.

Linked in our granary. ✔

[jaraco]

As we work to migrate projects from skeleton to coherent, it's going to be necessary to sync all of the project descriptions from the project metadata into GitHub. My guess is that can be done in a few lines of code by utilizing jaraco.develop.projects-run to extract the metadata and then set it using gh repo edit -d "$DESCRIPTION" for each project.