Skip to content

Show README or DESCRIPTION on project's home page. #963

Closed
docwhat opened this Issue Jun 22, 2012 · 30 comments
@docwhat
docwhat commented Jun 22, 2012

The description field was removed in 2.4 or 2.5. But nothing replaces it, which is really annoying.

This was very useful for showing information like:

  • A verbose description of the software.
  • Jenkins (a CI tool) job status.
  • Jenkins job URL.
  • Link to deployments.
  • Notes about usage, etc.

Can we either:

  1. Show the README on the home page?
  2. Show an alternative (maybe specified per project or globally) file?
  3. Show a hard-coded file like DESCRIPTION or GITLAB-DESCRIPTION?

Ciao!

@colindean

The readme shows on the files page, but I miss the description!

@vsizov
vsizov commented Jun 23, 2012

Sorry but the developers made ​​this decision. We can not meet the requirements of everybody.

Sorry for possible inconvenience.

@vsizov vsizov closed this Jun 23, 2012
@vsizov
vsizov commented Jun 23, 2012

Can you specify to place where you want see the description?. What your suggestion?

@docwhat
docwhat commented Jun 24, 2012

At the top of the home page for the project. I definitely need something to allow me to include import information about the project as I mentioned above.

Another alternative would be to be able to link a per-project specified wiki page to that spot. Just something so I can add additional information.

@vsizov
vsizov commented Jun 25, 2012

use wiki

@docwhat
docwhat commented Jun 26, 2012

The wiki isn't sufficient unless I can make the wiki front page the default "summary" page. This needs to be there so that people looking at the project(s) can figure out what they are, what their status is, and where to get more info.

@jamescasbon

+1 on showing the readme on the homepage.

You could consider a two column activity + readme page.

@michelkaeser

not sure about this. since gitlab is for private repos, I guess colaborators should have knowledge on what the project is about in gereral. and for deeper knowledge, the wiki is enough...my opinion.

@docwhat
docwhat commented Aug 23, 2012

I don't agree for multiple reasons:

  • People might be added to a project without knowing what it is. e.g. new hires, large teams, non-developer reviewers/QA, etc.
  • People might revisit a project after a while and need to have their memory refreshed.
  • There needs to be a way to link to related information, such as:
    • The CI system.
    • Known/Important issues.
    • Quick start info (either the actual text or a link to the wiki page).
    • Links to other wikis (corporate, etc.)
    • A place to post policy information, such as "This is confidential information..., see the info at ". This may be required by company policy.
    • Links to where the software is deployed, such as intranet services, etc.
    • Links to code review systems.
    • Links for how to get help or more information (IRC channels, Intranet IM, Intranet Twitter).

In the company I work for, for example, we're required to meet different standards for different projects. We need to be able to have prominently displayed notice for each project. This is not the same notice for each project.

@zenbaku
zenbaku commented Oct 7, 2012

I landed here for the same reason. Why is this not a top issue? It's really a simple thing (because it's already implemented in the Files tab) and it adds many benefits, outlined above.

@riyad
riyad commented Oct 8, 2012

+1

@oscherler

Another option is to follow the standard practice of using the filename to store metadata, and put the description in the project name:

git clone http://git@gitlab.initech.com/pc-load-letter_ruby-gem-used-in-a-webhook-to-automatically-add-the-cover-sheet-to-all-outgoing-tps-reports.git
@poorgeek
poorgeek commented Nov 9, 2012

+1
Would really like to have this decision reconsidered for the benefits outlined by @docwhat. At the very least make it configurable in the project settings as to what gets displayed when a user clicks on the Home tab.

@jokester01au

+1

I agree also. I strongly think that the front page should have USER configurable text to give readers a quick summary of what the project is, how to build it, etc....ie the readme.

@jbohren
jbohren commented Nov 29, 2012

+1

@MaddinXx

not sure about this. since gitlab is for private repos, I guess colaborators should have knowledge on what the project >is about in gereral. and for deeper knowledge, the wiki is enough...my opinion.

I'm using GitLab in an academic research environment where we have many graduate and undergraduate students who have limited to no prior software development experience. Having the option of having the Files tab, Wiki tab, or the rendered README show up on the landing page for a project would be really useful since it would make the system just that much more self-documenting.

@poorgeek

Given that GitLab, as of 4.1, is no longer just for private repositories, being able to provide instructions on the project home page would be nice.

@jbohren
jbohren commented Jan 30, 2013

@poorgeek

Given that GitLab, as of 4.1, is no longer just for private repositories, being able to provide instructions on the project home page would be nice.

Well, 4.1 allows public cloning but there is no actual public home page for a given project. That sounds like a reasonable idea, though, and might merit another feature request ticket.

@xavs
xavs commented Oct 22, 2013

+1 Would be a nice to have

@amercier

+1 That's one of the feature that made Github so popular IMHO. So I guess that would be nice to have this in GitLab as well.

@neerolyte

+1 showing README on the homepage (or having an option to).

@ckulla
ckulla commented Feb 27, 2014

+1 showing README on the homepage (or having an option to).

@geerlingguy

See: http://feedback.gitlab.com/forums/176466-general/suggestions/3907476-add-readme-to-project-home-view-or-make-files-t

From the official GitLab response on 12/2/13:

We added a link to the readme on the sidebar on the project homepage (activity page) for GitLab 6.4 https://gitlab.com/gitlab-org/gitlab-ce/commit/81fe86b4279775b3cbed2d64529d671d6fbe49d2 We realize that this is not the solution that many voters wanted and we are open to new suggestions. Please open a new request and include a screenshot. Replacing the activity page (even when configurable) is not an option we will consider.

@adc-tcarvalho

+1 showing README on the homepage (or having an option to).

@erunion
erunion commented Apr 22, 2014

Not to pile on, but +1 to having the option to show the README on the project homepage.

@mbrgm
mbrgm commented May 19, 2014

+1. Admin (or even users) should be able to have that config option.

@karlingen

+1 showing README on the homepage (or having an option to).

@brutaldev

+1 showing README on the homepage (or having an option to).

@jksdua
jksdua commented Jun 24, 2014

+1 for readme on the homepage. From memory, Bitbucket has a really neat project setting where you can pick what shows up on a project homepage.

@maxlazio
GitLab member
@maxlazio maxlazio locked and limited conversation to collaborators Jun 24, 2014
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Something went wrong with that request. Please try again.