Maven 1

Documentation enhancements

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Won't Fix
  • Affects Version/s: None
  • Fix Version/s: 1.1-beta-3
  • Component/s: documentation
  • Labels:
    None
  • Number of attachments :
    0

Description

Ok,
Here are some changes I would recommend (as dIon asked for it :
1) Change the welcome page to have direct links to gettting started. This is
what I want to see when I visit the front page
2) The user guide should have information from the download and install
sections to make it a more complete user's guide
3) getting started and user's guide should possibly be rethought into user's
guide and developer's guide.
4) The plug-ins should be split into core and additional (or optional)
5) Someone who has written a plug-in should write a plug-in development
howto and integrate that with the developer's guide.
6) Plug-ins should be described on the listing page
7) In the user's guide it would be nice to have a link to an example
maven.xml file

Let me know what you guys think, when I get a chance to look at it further I
may have some further suggestions (and maybe patches .

-warner

warner onstine

Issue Links

Activity

Hide
Ben Walding added a comment -

At least review the doco changes to see if they make sense

Show
Ben Walding added a comment - At least review the doco changes to see if they make sense
Hide
Ben Walding added a comment -

1) Already done.
2)
3)
4)
5)
6) Already Done.
7)

Show
Ben Walding added a comment - 1) Already done. 2) 3) 4) 5) 6) Already Done. 7)
Hide
Miguel Griffa added a comment -

I could get on 5 since I'm quite new to maven development and I'm writing my first plugin,. This makes me have some problems and issues quite fresh. Is anyone working on this already? Or shuold I start typing?

Show
Miguel Griffa added a comment - I could get on 5 since I'm quite new to maven development and I'm writing my first plugin,. This makes me have some problems and issues quite fresh. Is anyone working on this already? Or shuold I start typing?
Hide
Brett Porter added a comment -

documentation patches are welcome!

There are some documents like this on the Maven wiki - it would be worth looking at and borrowing some of that.

Show
Brett Porter added a comment - documentation patches are welcome! There are some documents like this on the Maven wiki - it would be worth looking at and borrowing some of that.
Hide
Lukas Theussl added a comment -

Closing as outdated. If someone thinks we should take something up, please open a separate issue.

Show
Lukas Theussl added a comment - Closing as outdated. If someone thinks we should take something up, please open a separate issue.

People

Vote (1)
Watch (2)

Dates

  • Created:
    Updated:
    Resolved: