harmony-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sian January" <sianjanu...@googlemail.com>
Subject Re: [jira] Commented: (HARMONY-2009) Brush up and update Eclipse-related docs, make them user-friendly.
Date Wed, 29 Nov 2006 10:50:58 GMT
Hi Nadya,

I'm replying to your comments on the dev list rather than in the JIRA itself
(HARMONY-2009) as this seemed like a discussion.  I have written
some responses inline, but I just wondered whether since there was no
response to the "Anybody tried DRLVM+Eclipse and can share?" thread if it
would be a good idea to remove the DRLVM section from that page.  I think we
had discussed this before in a previous thread.  What do you think?

Thanks,

Sian



On 28/11/06, Nadya Morozova (JIRA) <jira@apache.org> wrote:
>
>    [
> http://issues.apache.org/jira/browse/HARMONY-2009?page=comments#action_12454039]
>
> Nadya Morozova commented on HARMONY-2009:
> -----------------------------------------
>
> some review comments. please don't take too seriously - negotiations
> welcome.
>
> - Introduction: 1st sentence is about harmony, 2nd - about classlib only.
> what about drlvm? an intro to the kind of info on drlvm development tips
> would be great.


I'm not sure how useful the DRLVM information is here (see above comments),
but if we do decide to keep it I agree that we should include an
introductory paragraph.


- Prerequisites: (just curious) can there be people trying to work in
> eclipse but using something different from subclipse for svn transactions?


Yes - there's another Eclipse plug-in called Subversive although I'm not
sure if anyone in the Harmony community has tried it.

- Prerequisites: you require a classlib build, though the page is supposed
> to be for classlib+drlvm
> - spelling: is it "pre-requisites" or "prerequisites"? check
> merriam-webster, they suggest one word.


Let's use "prerequisites" if that's the one in the dictionary

- Configuring Eclipse: are all steps in this section classlib-specific?


Yes

- Configuring Eclipse: some steps seemt to assume that the reader is using
> Windows? can we make the text OS neutral and separate OS specifics?


Yes - it would be good to make it clear that some of the steps are specific
to Windows.

- Configuring Eclipse: please double-check formatting; sometimes, UI
> elements are in bold, at other times - monospace font; some UI elements are
> in quotes, others not. sticking to one notation could help. bold with no
> quotes seems to be shorter and easy to decipher, but i don't insist :)


I agree

- Configuring Eclipse: do you think we can separate Configuring Eclipse
> proper and, say, getting the source code (set up svn, check out, etc)? in
> the current list, steps 5-6 might as well be step 1 - right? can we have two
> grouping? also, the info about checkout is exactly the same for drlvm and
> classlib except for slight differences in the path. perhaps, we can have a
> section on Check Out Source Code. there, we could explain how to check out
> using eclipse-related means and provide a link to some other webpage
> explaining other ways of check out and related problems (say, working behind
> a firewall).


I think I would have to see what that looked like before commenting.  It
does seem to make sense, but I'm not sure if it would be confusing to have
so many sections in the page.

thanks, Nadya
>
>
> > Brush up and update Eclipse-related docs, make them user-friendly.
> > ------------------------------------------------------------------
> >
> >                 Key: HARMONY-2009
> >                 URL: http://issues.apache.org/jira/browse/HARMONY-2009
> >             Project: Harmony
> >          Issue Type: Improvement
> >          Components: Website/Documentation
> >            Reporter: Svetlana Konovalova
> >         Assigned To: Nadya Morozova
> >         Attachments: dev_eclipse.patch, dev_eclipse_patch.txt,
> get-involved_patch.txt, H2009-deveclipse.patch
> >
> >
> > The documentation doesn't cover all aspects of work with Eclipse. Need
> to brush up and update Eclipse-related docs, make them user-friendly.
>
> --
> This message is automatically generated by JIRA.
> -
> If you think it was sent incorrectly contact one of the administrators:
> http://issues.apache.org/jira/secure/Administrators.jspa
> -
> For more information on JIRA, see: http://www.atlassian.com/software/jira
>
>
>


-- 
Sian January

IBM Java Technology Centre, UK

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message