Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 418115

Summary: ProjectEditor should not render Reame.md
Product: [ECD] Orion Reporter: Silenio Quarti <Silenio_Quarti>
Component: ClientAssignee: Malgorzata Janczarska <malgorzata.tomczyk>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: antonm, malgorzata.tomczyk, simon_kaegi
Version: 4.0   
Target Milestone: 4.0 RC1   
Hardware: PC   
OS: Windows 7   
Whiteboard:
Attachments:
Description Flags
project editor
none
folder nav none

Description Silenio Quarti CLA 2013-09-26 11:39:56 EDT
Created attachment 235859 [details]
project editor

There are two places we render the readme.md file now (in folderView.js and in projectEditor.js).  I think only folderView.js should render it and anything that is done extra in the projectEditor.js should be moved to folderView.js (i.e. Edit and Create actions). That way we would have less code and the readme.md would always be shown after the folder nav.  Right now, it shows after when viewing a folder and before when viewing a project (see screenshots).
Comment 1 Silenio Quarti CLA 2013-09-26 11:40:22 EDT
Created attachment 235860 [details]
folder nav
Comment 2 Malgorzata Janczarska CLA 2013-09-26 11:52:35 EDT
So on the project page you would like to see them in this order:
1. Project Information
2. Assosiated Content
3. Files
4. Readme.md
and you would like to logic of rendering readme.md to the folderView.js?

I would personally prefer to display readme before files list on both views, because we have the folder list is duplicated with the left side navigator and if there are a lot of files in the folder user will not see the readme until he scrolls down.

What should I do with the "Create readme" action that is displayed when project does not have readme? Do we want to add it as well to the folder view?
Comment 3 Silenio Quarti CLA 2013-09-26 12:05:17 EDT
(In reply to Malgorzata Janczarska from comment #2)
> So on the project page you would like to see them in this order:
> 1. Project Information
> 2. Assosiated Content
> 3. Files
> 4. Readme.md
> and you would like to logic of rendering readme.md to the folderView.js?

Yes, that is what I had in mind. Antonm, I think that is the ordering we decided in that meeting (same as github), but I might be wrong. Do you remember?

> I would personally prefer to display readme before files list on both views,
> because we have the folder list is duplicated with the left side navigator
> and if there are a lot of files in the folder user will not see the readme
> until he scrolls down.

I understand, but some people actually want to collapse the mini-nav and just use the folder nav for navigation. And in that case the Readme.md first would make it harder.

> What should I do with the "Create readme" action that is displayed when
> project does not have readme? Do we want to add it as well to the folder
> view?

I think I would add the empty box with create action only if it is a project folder.  But maybe it is ok to have it all the time.
Comment 4 Malgorzata Janczarska CLA 2013-10-03 10:17:44 EDT
Done.