Issue #5655 open

Repository description does not appear in overview page

Vinay Sajip
created an issue

When you fork a repository for a specific reason, you put the reason for the fork in the description field in the Admin page for the repository. For example, I forked vinay.sajip/django from django/django-hg-git, I did it to provide a Python 3 port of Django. That work is now done, and while I will keep this repository around for a while (it contains some changes which didn't make it into Django upstream), I have updated the description to reflect that I'm not updating this repository any more. However, that information is not available through the UI, AFAICT, so users might still fork the repo thinking it's in active use. In fact, I just got a notification of a fork today.

Comments (10)

  1. Marcus Bertrand staff

    We currently only show the description in search results. We are in the process of updating the user profile page so that repositories listed for a user include the description.

    I think editing the README would be a good place to note the reason for your fork.

  2. Vinay Sajip reporter

    I think editing the README would be a good place to note the reason for your fork.

    Won't any changes made there show up in pull requests? It increases the noise factor for upstream. Is there a good reason that you can't show the repository admin description in the overview page? If it's a screen real estate issue, you could consider making it visible in a tooltip-style pop-up when you hover over some part of the page.

  3. Aleksandr Gidenko (American Red Cross)

    I also agree, the description should appear on the overview page. I don't want to make any custom changes in the README about my fork as these changes will show up in pull requests. Please update the UI to include the description and README on the overview page.

  4. Patrick O'Keeffe

    I've always been puzzled why I should invest the effort to fill out a 'description' field which is never shown to users.... well, I just tried searching and the resulting presentation with descriptions is great. How much longer before user profiles have descriptions too? That will be quite nice.

    We are in the process of updating the user profile page so that repositories listed for a user include the description. [Dec 2012]

    Vinay Sajip is right though: I can't think of a single good reason the box on the Overview page containing Last Updated, Language, and Access Level should not also contain the project's description -- it currently has a nice blank area to fill. A one sentence description and README file serve different purposes.

  5. Vinay Sajip reporter

    A one sentence description and README file serve different purposes.

    Right - the README's scope is more general - the project as a whole (i.e. potentially the same across forks), whereas the description is for one specific repository only (it could be copied to a newly-created fork, but not synced if changed in either repository afterwards).

  6. kopytmyk

    Why then did I bother writing a long description of my fork, and then it disappeared?! I want that other people may see the description of THIS fork. I also want to see other people's fork desriptions. Maybe forking is not necessary. How the h... I would know what each of 125 forks are?!!!

  7. Michael Sheehan

    Marcus Bertrand Can you look into this again? The description is already in the HTML: <meta name="og:description" content="Hello World"/> It's pretty ridiculous to not have a way to view this on a repo's overview when you have all the other screen clutter.

  8. Log in to comment