[Sub Issue] Project Home README.md

Resources

FE @iamphill

Meta issue: https://gitlab.com/gitlab-org/gitlab-ce/issues/13680

Design

So both:

• https://gitlab.com/gitlab-org/gitlab-ce
• https://gitlab.com/gitlab-org/gitlab-ce/tree/master

should be adjusted to look like: https://gitlab.com/gitlab-org/gitlab-ce/issues/20919#note_19320942

mentioned in issue #13680 (moved)

Changing the width of the readme would allow us to increase the size of the anchor icons and padding for the header tags. This would make it more accessible for users to use.

@ClemMakesApps I agree, typography can be improved for hierarchy clarity. However we should look upon this carefully to see where it would impact other view. Maybe create another issue for this.

Assignee removed

Mentioned in issue #13680 (moved)

A - README.md container style as same as README.md container in Repository page.

• The container width is changed from 1280px to 980px. And the content width is changed to be 700px.
• Changelog, MIT License, Contribution guide, and CI configuration links are collapsed.

Screen: 1280px

Screen: 1920px

---

B - README.md container is as same as current style.

• The container width is changed to be 790px.
• Changelog, MIT License, Contribution guide, and CI configuration links are collapsed.

Screen: 1280px

Screen: 1920px

---

If we want to keep the README.md style consistent, maybe we can select A.

assigned to @hazelyang

These numbers should match the other container/line length numbers right? 958px for container width, 700px for line length? https://gitlab.com/gitlab-org/gitlab-ce/issues/20919#note_19320942

We should be consistent for all of these line length issues.

• The container width is changed to be 958px.
• The content width is changed to be 700px.
• Changelog, MIT License, Contribution guide, and CI configuration links are collapsed.

Screen: 1280px

Screen: 1920px

added ~1434245 ~974571 labels

changed milestone to %Backlog

removed assignee

added frontend and removed ~19492 labels

mentioned in merge request !10346 (merged)

closed via merge request !10346 (merged)

there has been made a slight change to

So this needs a small update in terms of design. The idea is that the repository table stays wide, but the readme text section gets adjusted

@hazelyang what do you think about just making the internals of the readme section conform to the line length rules?

reopened

What is the reason for having them at different widths?

@tauriedavis see discussion here https://gitlab.slack.com/archives/C03MSG8B7/p1491487506273198

basically, currently the width container also limits the width of the repository table that has been added to project => home. This is not an ui element that should be limited by the same limits that are in place to limit body texts

Why is the width of repository not a ui element that should be limited?

I'm not against just shortening the content within the readme section but I'd like to understand the reasoning.

what do you think about just making the internals of the readme section conform to the line length rules?

@dimitrieh I prefer they have the same width as the screen looks neat and clean... But I am also curious about the reason you want to change it.

mentioned in merge request !10542 (merged)

My reasoning for not limiting the file view line length:

I know we should be limiting line-length for readability, but the file view already had readable line lengths, and the smaller width is forcing things to wrap when we used to have plenty of room. Something about it looks off when you see how much white space there is on either side.

But it does look better when the files & readme line up properly. So I don't have a good solution

cc @ClemMakesApps

From what I can tell, only two things are wrapping.

The first are the project links under the project-home-panel. This can be fixed with mockups provided by @hazelyang here https://gitlab.com/gitlab-org/gitlab-ce/issues/20914#note_19320421

The second is the last commit within the table. This is already truncated today and just needs further truncation.

I'm not sure white space is a reason for having two container widths.

Truncating is fine, but it was nice being able to read more of the content within the file table.

Is there a separate issue to add project links to a dropdown? It seems this issue was closed by https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/10346, which only changed the project view width.

No, I didn't notice those designs until earlier today since they weren't in the description of this issue :( I'm kind of confused what was landed on here after looking back at the comments, and it's different now with the addition of the repo which wasn't there before.

If it's easier, we can remove the limited width until we have a better definition of when and where to limit the container.

Sounds good. Updated https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/10542

Thanks @annabeldunstone

mentioned in merge request !10450 (closed)

I like a smaller width readme but I also agree that decreasing the width of the repository view (on projects page) does effectively remove any helpful content from the last commit section (depending on the length of the commit message)

added Deliverable label

changed milestone to %9.4

changed the description

mentioned in issue #20919 (closed)

to clarify from: https://gitlab.com/gitlab-org/gitlab-ce/issues/20919#note_32209586

@iamphill yes, as back when this issue was made.. the files table was not yet in the "project's home" view.

So both:

• https://gitlab.com/gitlab-org/gitlab-ce

• https://gitlab.com/gitlab-org/gitlab-ce/tree/master

should be adjusted to look like: https://gitlab.com/gitlab-org/gitlab-ce/issues/20919#note_19320942

changed the description

updated issue description

see: https://gitlab.com/gitlab-org/gitlab-ce/issues/20919#note_32314678

closed