Bug 486037 - Improve JSDT development docs
Summary: Improve JSDT development docs
Status: NEW
Alias: None
Product: JSDT
Classification: WebTools
Component: General (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows 10
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Patrik Suzzi CLA
QA Contact: Victor Rubezhny CLA
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2016-01-18 08:18 EST by Patrik Suzzi CLA
Modified: 2018-11-22 17:32 EST (History)
3 users (show)

See Also:


Attachments
jsdtProjects.psf equivalent to the one linked in docs (2.93 KB, application/octet-stream)
2016-02-01 21:47 EST, Patrik Suzzi CLA
no flags Details
Gerrit Projectset equivalent to the old one (2.46 KB, application/octet-stream)
2016-02-07 20:33 EST, Patrik Suzzi CLA
no flags Details
see the structure of projects in new projectSet.psf (63.52 KB, image/png)
2016-02-08 17:24 EST, Patrik Suzzi CLA
no flags Details
wst.jsdt.all-projects projectset (11.87 KB, application/octet-stream)
2016-02-09 09:57 EST, Patrik Suzzi CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Patrik Suzzi CLA 2016-01-18 08:18:57 EST
Improve JSDT development documentation #1 

I'm going to edit the section "Contributing to JSDT", 
by adding two subsections: 
 - "Environment setup": explaining how to setup the IDE
 - "Dev Resources": practical references on how to setup simple, working, examples on how to use JSDT 

I will be following the idea on #2
Any suggestion is welcome. 

References:
#1 https://wiki.eclipse.org/JSDT/Development
#2 https://docs.google.com/document/d/14A1GWo9PfwaV2IM2W8knaJXW2NlGN-WRp0MYoCfJnIA/edit?usp=sharing
Comment 1 Gorkem Ercan CLA 2016-01-19 19:25:45 EST
I like the idea of having a .psf file created for JSDT. I think psf should only include the JSDT project and we should get the dependencies either by downloading a WTP build or through a target platform. Considering the lack of a target platform for JSDT, I would start with idea on #2.
Comment 2 Patrik Suzzi CLA 2016-01-26 11:21:47 EST
I wrote an article explaining how to setup the JSDT development environment #3. 
The article is not linked to the JSDT Development page #1 and it contains a simple JSDT projectSet #4 

I can improve the JSDT Development page #1, by adding the jsdtSimpleProjectSet.psf #4 to the source code, maybe in a jsdt subproject. 

Where is the the location to add the projectSet ?

#1 https://wiki.eclipse.org/JSDT/Development
#3 http://www.asegno.com/2016/eclipse/jsdt-development/, it is not linked to the
#4 http://www.asegno.com/wp-content/uploads/2016/01/jsdtSimpleProjectSet.psf
Comment 3 Victor Rubezhny CLA 2016-02-01 18:07:59 EST
Patrik,

did you tried this PSF: https://www.eclipse.org/webtools/jsdt/psf/jsdt.psf ?

Is it usable? Does it requires to be updated/replaced?

You can find the link to that PSF at https://www.eclipse.org/webtools/jsdt/
Comment 4 Patrik Suzzi CLA 2016-02-01 21:47:03 EST
Created attachment 259476 [details]
jsdtProjects.psf equivalent to the one linked in docs

I tried it, but I couldn't use as it was, because of non/anonymous cvs entries. So I extracted the list of projects, and I created a Gerrit equivalent. 

You find the new .psf attached. 

It is equivalent to the one you pointed, except for the below Notes: 
- to load the .psf you need to install cvs plugin on your eclipse IDE
- I couldn't map the "releng.jsdt" project into a git repository
- I added the org.mozilla.javascript 1.7.4(*) as used in jee mars.1

(*) with org.mozilla.javascript 1.7.2 you get rid of compile errors, 
but it is not in sync with version 1.7.4 that is shipped with jee mars. 
See also 462695, maybe we should open a new bug
Comment 5 Patrik Suzzi CLA 2016-02-07 20:33:47 EST
Created attachment 259621 [details]
Gerrit Projectset equivalent to the old one

The attached projectset is equivalent to the one linked in docs, 
except the repositories are changed. 

The main difference is:
- Current development is done only on the webtools.jsdt repository.
- No development was done in last years against the other repositories, so webtools.jsdt.core; webtools.jsdt.debug and webtools.jsdt.tests are unused, 

Therefore, the new projectSet.psf references the webtools.jsdt repo only.
Comment 6 Patrik Suzzi CLA 2016-02-08 17:24:18 EST
Created attachment 259643 [details]
see the structure of projects in new projectSet.psf


The image represents the projects in the working set(*1), 
and expresses a clear structure for them. 

I think to document properly the JSDT project structure, we will need to describe:
- The JSDT standard tools (*1)
- The Nodejs tools 
- The JSON Editor
- The Web tools (HTML, JSP)

(*1) equivalent to those in comment3

Am I missing something / any feedback / suggestions ?
Comment 7 Patrik Suzzi CLA 2016-02-09 09:57:51 EST
Created attachment 259660 [details]
wst.jsdt.all-projects projectset

I wrote a new post explaining the overall structure of JSDT Projects 

http://www.asegno.com/2016/eclipse/jsdt-project-structure/

In the article there is a "Global" projectset, referencing all the projects in the JSDT panorama. 

As I explain in the post, I divided the JSDT projects in 4 logical project sets:  
- JSDT classic: Core, Debug, Docs (& Tests)
- JSDT.js: Nodejs stuff, i.e.: Bower, Gulp, Grunt
- wst.json: implementation oj JSON editor in webtools
- wst.jsdt.web: HTML, JSP and other editors integrating JSDT

Plus there are two more projectset, one for the (needed) platform runtime and another for the documentation (git only, so patches are needed)

If the psf is correct, and you like the split,this is an opportunity to work all together on the same codebase, with a clear distinction of projects by projectset.
Comment 8 Gorkem Ercan CLA 2016-02-09 11:16:38 EST
I am not sure if the org.eclipse.core.expressions needs to be pulled into the workspace?
I think it should be coming form the target platform.