You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@shindig.apache.org by "Vincent Siveton (JIRA)" <ji...@apache.org> on 2008/05/20 14:14:55 UTC
[jira] Created: (SHINDIG-283) Find a place to put documentation
Find a place to put documentation
---------------------------------
Key: SHINDIG-283
URL: https://issues.apache.org/jira/browse/SHINDIG-283
Project: Shindig
Issue Type: Task
Components: Website
Reporter: Vincent Siveton
Actually, the Shindig doc is mainly in README files, which is not very user friendly.
So, we need to decide where to put Shindig documentation. I see the following options, each with pros and cons:
* Maven project
* Confluence
* other ??
The documentation should include:
* user docs and FAQ on how to set Shindig in production, how to build it...
* developer docs
* project docs like ML, SVN...
The documentation needs to be up to date so we need to release it often.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (SHINDIG-283) Find a place to put documentation
Posted by "Vincent Siveton (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SHINDIG-283?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12598281#action_12598281 ]
Vincent Siveton commented on SHINDIG-283:
-----------------------------------------
BTW I could create a Maven project for doc and apply Erel's suggestions. Just ping me if it is the wanted solution.
> Find a place to put documentation
> ---------------------------------
>
> Key: SHINDIG-283
> URL: https://issues.apache.org/jira/browse/SHINDIG-283
> Project: Shindig
> Issue Type: Task
> Components: Website
> Reporter: Vincent Siveton
>
> Actually, the Shindig doc is mainly in README files, which is not very user friendly.
> So, we need to decide where to put Shindig documentation. I see the following options, each with pros and cons:
> * Maven project
> * Confluence
> * other ??
> The documentation should include:
> * user docs and FAQ on how to set Shindig in production, how to build it...
> * developer docs
> * project docs like ML, SVN...
> The documentation needs to be up to date so we need to release it often.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (SHINDIG-283) Find a place to put documentation
Posted by "Erel Segal (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SHINDIG-283?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12598276#action_12598276 ]
Erel Segal commented on SHINDIG-283:
------------------------------------
Some easy first steps:
a. Convert the readme files in the SVN (BUILD-JAVA etc.) to HTML format.
b. Move those files to a subdirectory "doc" and arrange them like a website (e.g. have an index.html that links to other files, etc). This directory will be in the SVN so it will be easy to update.
c. remove the links to the readme files from here: http://incubator.apache.org/shindig/#Additonal_reading . They are out of date and confuse new users. Instead, there should be links to the HTML files that will be in the SVN.
> Find a place to put documentation
> ---------------------------------
>
> Key: SHINDIG-283
> URL: https://issues.apache.org/jira/browse/SHINDIG-283
> Project: Shindig
> Issue Type: Task
> Components: Website
> Reporter: Vincent Siveton
>
> Actually, the Shindig doc is mainly in README files, which is not very user friendly.
> So, we need to decide where to put Shindig documentation. I see the following options, each with pros and cons:
> * Maven project
> * Confluence
> * other ??
> The documentation should include:
> * user docs and FAQ on how to set Shindig in production, how to build it...
> * developer docs
> * project docs like ML, SVN...
> The documentation needs to be up to date so we need to release it often.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (SHINDIG-283) Find a place to put documentation
Posted by "Vincent Siveton (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SHINDIG-283?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12598280#action_12598280 ]
Vincent Siveton commented on SHINDIG-283:
-----------------------------------------
IMHO it sounds like more a workaround than a long term solution
> Find a place to put documentation
> ---------------------------------
>
> Key: SHINDIG-283
> URL: https://issues.apache.org/jira/browse/SHINDIG-283
> Project: Shindig
> Issue Type: Task
> Components: Website
> Reporter: Vincent Siveton
>
> Actually, the Shindig doc is mainly in README files, which is not very user friendly.
> So, we need to decide where to put Shindig documentation. I see the following options, each with pros and cons:
> * Maven project
> * Confluence
> * other ??
> The documentation should include:
> * user docs and FAQ on how to set Shindig in production, how to build it...
> * developer docs
> * project docs like ML, SVN...
> The documentation needs to be up to date so we need to release it often.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.