Documentation Plan
|
View:
New views
11 Messages
—
Rating Filter:
Alert me
|
 |
Documentation Plan
by Emmanuel Venisse
::
Rate this Message:
Hi,
Here is the structure of the documentation I'd like to have for 1.1-final. Installation/Upgrade Guides Installation (standalone, webapp, service...) Release Notes Upgrade Administrator's Guides Managing Users and Security Adding Project Group Managing Builders Managing JDKs Managing Profiles Managing Schedules Managing General Configuration (configuration and appearance) Developer's Guides SVN repository structure XML-RPC TO BE DEFINED User's Guides Managing a project Add (maven1, maven2, Ant, Shell), Remove, Edit SCM security hints Managing Build Definitions Managing Notification mail to an address, mail to latest committers, irc, jabber, msn, wagon, alwaysSend... Building a project Release Management Knowledge Base FAQ (sorted by categories, maybe one menu entry by category) Old versions 1.0.x site About videos, I don't know yet where to put them. Maybe a video attached to a page (like Add Maven2 project) instead of a specific videos page in the menu. WDYT? Emmanuel |
|
|
Re: Documentation Plan
by Emmanuel Venisse
::
Rate this Message:
For 1.0.3 doc, we'll let it as is but we must remove specific 1.1 doc in it.
Emmanuel Emmanuel Venisse a écrit : > Hi, > > Here is the structure of the documentation I'd like to have for 1.1-final. > > > Installation/Upgrade Guides > Installation (standalone, webapp, service...) > Release Notes > Upgrade > Administrator's Guides > Managing Users and Security > Adding Project Group > Managing Builders > Managing JDKs > Managing Profiles > Managing Schedules > Managing General Configuration (configuration and appearance) > Developer's Guides > SVN repository structure > XML-RPC > TO BE DEFINED > User's Guides > Managing a project > Add (maven1, maven2, Ant, Shell), Remove, Edit > SCM security hints > Managing Build Definitions > Managing Notification > mail to an address, mail to latest committers, irc, jabber, > msn, wagon, alwaysSend... > Building a project > Release Management > Knowledge Base > FAQ (sorted by categories, maybe one menu entry by category) > Old versions > 1.0.x site > > > About videos, I don't know yet where to put them. Maybe a video attached > to a page (like Add Maven2 project) instead of a specific videos page in > the menu. > > WDYT? > > Emmanuel > > > |
|
|
Re: Documentation Plan
by Joakim Erdfelt-2
::
Rate this Message:
The order is a little odd.
I would personally put the User's Guide as more important than the Developer's Guides. The FAQ should be higher in the list too. - Joakim Emmanuel Venisse wrote: > Hi, > > Here is the structure of the documentation I'd like to have for > 1.1-final. > > > Installation/Upgrade Guides > Installation (standalone, webapp, service...) > Release Notes > Upgrade > Administrator's Guides > Managing Users and Security > Adding Project Group > Managing Builders > Managing JDKs > Managing Profiles > Managing Schedules > Managing General Configuration (configuration and appearance) > Developer's Guides > SVN repository structure > XML-RPC > TO BE DEFINED > User's Guides > Managing a project > Add (maven1, maven2, Ant, Shell), Remove, Edit > SCM security hints > Managing Build Definitions > Managing Notification > mail to an address, mail to latest committers, irc, > jabber, msn, wagon, alwaysSend... > Building a project > Release Management > Knowledge Base > FAQ (sorted by categories, maybe one menu entry by category) > Old versions > 1.0.x site > > > About videos, I don't know yet where to put them. Maybe a video > attached to a page (like Add Maven2 project) instead of a specific > videos page in the menu. > > WDYT? > > Emmanuel > -- - Joakim Erdfelt joakim@... Open Source Software (OSS) Developer |
|
|
Re: Documentation Plan
by olamy-2
::
Rate this Message:
Agree on this comments.
User Guide could be the second entry. The structure is fine. (now we have to populate this) -- Olivier 2007/9/24, Joakim Erdfelt <joakim@...>: > > The order is a little odd. > I would personally put the User's Guide as more important than the > Developer's Guides. > The FAQ should be higher in the list too. > > - Joakim > > > Emmanuel Venisse wrote: > > Hi, > > > > Here is the structure of the documentation I'd like to have for > > 1.1-final. > > > > > > Installation/Upgrade Guides > > Installation (standalone, webapp, service...) > > Release Notes > > Upgrade > > Administrator's Guides > > Managing Users and Security > > Adding Project Group > > Managing Builders > > Managing JDKs > > Managing Profiles > > Managing Schedules > > Managing General Configuration (configuration and appearance) > > Developer's Guides > > SVN repository structure > > XML-RPC > > TO BE DEFINED > > User's Guides > > Managing a project > > Add (maven1, maven2, Ant, Shell), Remove, Edit > > SCM security hints > > Managing Build Definitions > > Managing Notification > > mail to an address, mail to latest committers, irc, > > jabber, msn, wagon, alwaysSend... > > Building a project > > Release Management > > Knowledge Base > > FAQ (sorted by categories, maybe one menu entry by category) > > Old versions > > 1.0.x site > > > > > > About videos, I don't know yet where to put them. Maybe a video > > attached to a page (like Add Maven2 project) instead of a specific > > videos page in the menu. > > > > WDYT? > > > > Emmanuel > > > > > -- > - Joakim Erdfelt > joakim@... > Open Source Software (OSS) Developer > > |
|
|
Re: Documentation Plan
by Wendy Smoak-3
::
Rate this Message:
On 9/24/07, Emmanuel Venisse <emmanuel@...> wrote:
> For 1.0.3 doc, we'll let it as is but we must remove specific 1.1 doc in it. How will this be handled? Do we need continuum/1.0.3 and continuum/1.1 on the website? -- Wendy |
|
|
Re: Documentation Plan
by Emmanuel Venisse
::
Rate this Message:
I'm agree
Emmanuel Joakim Erdfelt a écrit : > The order is a little odd. > I would personally put the User's Guide as more important than the > Developer's Guides. > The FAQ should be higher in the list too. > > - Joakim > > > Emmanuel Venisse wrote: >> Hi, >> >> Here is the structure of the documentation I'd like to have for >> 1.1-final. >> >> >> Installation/Upgrade Guides >> Installation (standalone, webapp, service...) >> Release Notes >> Upgrade >> Administrator's Guides >> Managing Users and Security >> Adding Project Group >> Managing Builders >> Managing JDKs >> Managing Profiles >> Managing Schedules >> Managing General Configuration (configuration and appearance) >> Developer's Guides >> SVN repository structure >> XML-RPC >> TO BE DEFINED >> User's Guides >> Managing a project >> Add (maven1, maven2, Ant, Shell), Remove, Edit >> SCM security hints >> Managing Build Definitions >> Managing Notification >> mail to an address, mail to latest committers, irc, >> jabber, msn, wagon, alwaysSend... >> Building a project >> Release Management >> Knowledge Base >> FAQ (sorted by categories, maybe one menu entry by category) >> Old versions >> 1.0.x site >> >> >> About videos, I don't know yet where to put them. Maybe a video >> attached to a page (like Add Maven2 project) instead of a specific >> videos page in the menu. >> >> WDYT? >> >> Emmanuel >> > > |
|
|
Re: Documentation Plan
by Emmanuel Venisse
::
Rate this Message:
Wendy Smoak a écrit : > On 9/24/07, Emmanuel Venisse <emmanuel@...> wrote: > >> For 1.0.3 doc, we'll let it as is but we must remove specific 1.1 doc in it. > > How will this be handled? Do we need continuum/1.0.3 and > continuum/1.1 on the website? I don't know but if we remove 1.0.3 doc, how 1.0.3 users will read it? Emmanuel |
|
|
Re: Documentation Plan
by brettporter
::
Rate this Message:
The layout below with stated modifications sounds good to me.
See also on archiva-dev today: <B77F0688-E66D-4D24-A65E- D33B11EF87D0@...> under "[proposal] Move Archiva's wiki to cwiki.apache.org" for the different types I'd like to see. I think the documentation can be deployed to /docs/1.1, /docs/1.0.3, etc. Cheers, Brett On 25/09/2007, at 9:55 PM, Emmanuel Venisse wrote: > I'm agree > > Emmanuel > > Joakim Erdfelt a écrit : >> The order is a little odd. >> I would personally put the User's Guide as more important than the >> Developer's Guides. >> The FAQ should be higher in the list too. >> - Joakim >> Emmanuel Venisse wrote: >>> Hi, >>> >>> Here is the structure of the documentation I'd like to have for >>> 1.1-final. >>> >>> >>> Installation/Upgrade Guides >>> Installation (standalone, webapp, service...) >>> Release Notes >>> Upgrade >>> Administrator's Guides >>> Managing Users and Security >>> Adding Project Group >>> Managing Builders >>> Managing JDKs >>> Managing Profiles >>> Managing Schedules >>> Managing General Configuration (configuration and >>> appearance) >>> Developer's Guides >>> SVN repository structure >>> XML-RPC >>> TO BE DEFINED >>> User's Guides >>> Managing a project >>> Add (maven1, maven2, Ant, Shell), Remove, Edit >>> SCM security hints >>> Managing Build Definitions >>> Managing Notification >>> mail to an address, mail to latest committers, irc, >>> jabber, msn, wagon, alwaysSend... >>> Building a project >>> Release Management >>> Knowledge Base >>> FAQ (sorted by categories, maybe one menu entry by category) >>> Old versions >>> 1.0.x site >>> >>> >>> About videos, I don't know yet where to put them. Maybe a video >>> attached to a page (like Add Maven2 project) instead of a >>> specific videos page in the menu. >>> >>> WDYT? >>> >>> Emmanuel >>> -- Brett Porter - brett@... Blog: http://www.devzuz.org/blogs/bporter/ |
|
|
Re: Documentation Plan
by Emmanuel Venisse
::
Rate this Message:
I created a branch for the new site (http://svn.apache.org/repos/asf/maven/continuum/branches/continuum-site_1.1/) and I added the structure and some content.
Please, review and comment before I (and all other that want to help) start to write the doc. Emmanuel Emmanuel Venisse a écrit : > Hi, > > Here is the structure of the documentation I'd like to have for 1.1-final. > > > Installation/Upgrade Guides > Installation (standalone, webapp, service...) > Release Notes > Upgrade > Administrator's Guides > Managing Users and Security > Adding Project Group > Managing Builders > Managing JDKs > Managing Profiles > Managing Schedules > Managing General Configuration (configuration and appearance) > Developer's Guides > SVN repository structure > XML-RPC > TO BE DEFINED > User's Guides > Managing a project > Add (maven1, maven2, Ant, Shell), Remove, Edit > SCM security hints > Managing Build Definitions > Managing Notification > mail to an address, mail to latest committers, irc, jabber, > msn, wagon, alwaysSend... > Building a project > Release Management > Knowledge Base > FAQ (sorted by categories, maybe one menu entry by category) > Old versions > 1.0.x site > > > About videos, I don't know yet where to put them. Maybe a video attached > to a page (like Add Maven2 project) instead of a specific videos page in > the menu. > > WDYT? > > Emmanuel > > > |
|
|
Re: Documentation Plan
by Emmanuel Venisse
::
Rate this Message:
What do you think if I remove "Old versions" from the menu? We don't have a 1.0.x doc so we don't need it and I don't know what toput in this part.
It can be used with next versions Emmanuel Emmanuel Venisse a écrit : > I created a branch for the new site > (http://svn.apache.org/repos/asf/maven/continuum/branches/continuum-site_1.1/) > and I added the structure and some content. > > Please, review and comment before I (and all other that want to help) > start to write the doc. > > Emmanuel > > Emmanuel Venisse a écrit : >> Hi, >> >> Here is the structure of the documentation I'd like to have for >> 1.1-final. >> >> >> Installation/Upgrade Guides >> Installation (standalone, webapp, service...) >> Release Notes >> Upgrade >> Administrator's Guides >> Managing Users and Security >> Adding Project Group >> Managing Builders >> Managing JDKs >> Managing Profiles >> Managing Schedules >> Managing General Configuration (configuration and appearance) >> Developer's Guides >> SVN repository structure >> XML-RPC >> TO BE DEFINED >> User's Guides >> Managing a project >> Add (maven1, maven2, Ant, Shell), Remove, Edit >> SCM security hints >> Managing Build Definitions >> Managing Notification >> mail to an address, mail to latest committers, irc, >> jabber, msn, wagon, alwaysSend... >> Building a project >> Release Management >> Knowledge Base >> FAQ (sorted by categories, maybe one menu entry by category) >> Old versions >> 1.0.x site >> >> >> About videos, I don't know yet where to put them. Maybe a video >> attached to a page (like Add Maven2 project) instead of a specific >> videos page in the menu. >> >> WDYT? >> >> Emmanuel >> >> >> > > > |
|
|
Re: Documentation Plan
by olamy-2
::
Rate this Message:
Agree to remove old content.
The home need some work : adding the download link, google search box as in maven home and some more words on the project. -- Olivier 2007/10/5, Emmanuel Venisse < emmanuel@...>: > > What do you think if I remove "Old versions" from the menu? We don't have > a 1.0.x doc so we don't need it and I don't know what toput in this part. > It can be used with next versions > > Emmanuel > > Emmanuel Venisse a écrit : > > I created a branch for the new site > > (http://svn.apache.org/repos/asf/maven/continuum/branches/continuum-site_1.1/ > ) > > and I added the structure and some content. > > > > Please, review and comment before I (and all other that want to help) > > start to write the doc. > > > > Emmanuel > > > > Emmanuel Venisse a écrit : > >> Hi, > >> > >> Here is the structure of the documentation I'd like to have for > >> 1.1-final . > >> > >> > >> Installation/Upgrade Guides > >> Installation (standalone, webapp, service...) > >> Release Notes > >> Upgrade > >> Administrator's Guides > >> Managing Users and Security > >> Adding Project Group > >> Managing Builders > >> Managing JDKs > >> Managing Profiles > >> Managing Schedules > >> Managing General Configuration (configuration and appearance) > >> Developer's Guides > >> SVN repository structure > >> XML-RPC > >> TO BE DEFINED > >> User's Guides > >> Managing a project > >> Add (maven1, maven2, Ant, Shell), Remove, Edit > >> SCM security hints > >> Managing Build Definitions > >> Managing Notification > >> mail to an address, mail to latest committers, irc, > >> jabber, msn, wagon, alwaysSend... > >> Building a project > >> Release Management > >> Knowledge Base > >> FAQ (sorted by categories, maybe one menu entry by category) > >> Old versions > >> 1.0.x site > >> > >> > >> About videos, I don't know yet where to put them. Maybe a video > >> attached to a page (like Add Maven2 project) instead of a specific > >> videos page in the menu. > >> > >> WDYT? > >> > >> Emmanuel > >> > >> > >> > > > > > > > > -- Olivier |
| Free embeddable forum powered by Nabble | Forum Help |
