You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cayenne.apache.org by "Borut Bolcina (JIRA)" <ji...@apache.org> on 2010/11/05 13:57:44 UTC
[jira] Created: (CAY-1501) JavaDoc for Cayenne 3.0 link in the menu
shows Cayenne Documentation 3.0-SNAPSHOT API
JavaDoc for Cayenne 3.0 link in the menu shows Cayenne Documentation 3.0-SNAPSHOT API
--------------------------------------------------------------------------------------
Key: CAY-1501
URL: https://issues.apache.org/jira/browse/CAY-1501
Project: Cayenne
Issue Type: Bug
Components: Documentation
Affects Versions: 3.0.1
Reporter: Borut Bolcina
There should be 3.0.1 API version, not the 3.0-SNAPSHOT API when accessed from the menu on the official site.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (CAY-1501) JavaDoc for Cayenne 3.0 link in the
menu shows Cayenne Documentation 3.0-SNAPSHOT API
Posted by "Ari Maniatis (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CAY-1501?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12929324#action_12929324 ]
Ari Maniatis commented on CAY-1501:
-----------------------------------
It is actually tracking http://svn.apache.org/repos/asf/cayenne/main/branches/STABLE-3.0
To my mind, that is correct and what is expected here. The documentation cwiki also tracks the stable-3 branch and not individual point releases. Do any other developers have an opinion on this, or should be close this task?
> JavaDoc for Cayenne 3.0 link in the menu shows Cayenne Documentation 3.0-SNAPSHOT API
> --------------------------------------------------------------------------------------
>
> Key: CAY-1501
> URL: https://issues.apache.org/jira/browse/CAY-1501
> Project: Cayenne
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 3.0.1
> Reporter: Borut Bolcina
>
> There should be 3.0.1 API version, not the 3.0-SNAPSHOT API when accessed from the menu on the official site.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (CAY-1501) JavaDoc for Cayenne 3.0 link in the
menu shows Cayenne Documentation 3.0-SNAPSHOT API
Posted by "Ari Maniatis (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CAY-1501?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12929461#action_12929461 ]
Ari Maniatis commented on CAY-1501:
-----------------------------------
I agree that 3.0-SNAPSHOT is confusing as a name. Remember that this is tied back to the hudson builds which are most useful when tracking the branch, not the individual tags. If we want these docs to track the releases, then we'd need to add the publishing of javadocs as a step in the release process to be done by hand, instead of published from Hudson.
The actual Javadocs are probably what is expected, since we don't make API changes within the branch. It is extremely rare that we'd make any change at all which alters the javadocs within a stable branch. But the name is confusing. Would it be enough to just use sed to fix that?
> JavaDoc for Cayenne 3.0 link in the menu shows Cayenne Documentation 3.0-SNAPSHOT API
> --------------------------------------------------------------------------------------
>
> Key: CAY-1501
> URL: https://issues.apache.org/jira/browse/CAY-1501
> Project: Cayenne
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 3.0.1
> Reporter: Borut Bolcina
>
> There should be 3.0.1 API version, not the 3.0-SNAPSHOT API when accessed from the menu on the official site.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (CAY-1501) JavaDoc for Cayenne 3.0 link in the
menu shows Cayenne Documentation 3.0-SNAPSHOT API
Posted by "Andrus Adamchik (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CAY-1501?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12929584#action_12929584 ]
Andrus Adamchik commented on CAY-1501:
--------------------------------------
I am ok if we move it from Hudson to a manual process done once after the release.
> JavaDoc for Cayenne 3.0 link in the menu shows Cayenne Documentation 3.0-SNAPSHOT API
> --------------------------------------------------------------------------------------
>
> Key: CAY-1501
> URL: https://issues.apache.org/jira/browse/CAY-1501
> Project: Cayenne
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 3.0.1
> Reporter: Borut Bolcina
>
> There should be 3.0.1 API version, not the 3.0-SNAPSHOT API when accessed from the menu on the official site.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (CAY-1501) JavaDoc for Cayenne 3.0 link in the
menu shows Cayenne Documentation 3.0-SNAPSHOT API
Posted by "Andrus Adamchik (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CAY-1501?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12929413#action_12929413 ]
Andrus Adamchik commented on CAY-1501:
--------------------------------------
I suspect our current approach can be a bit confusing to the end user ("what's a 3.0-SNAPSHOT?" ... even worse, the active branch may have API that is not yet available to anyone)... So thinking about it some more... Maybe the way to resolve it is to actually generate Javadocs for the last officially released version of a given branch? Then we can publish Javadocs each time after the release. I.e. the site is for the end users, not for Cayenne developers.
Of course 3.1 will be an exception until we make an official 3.1M1.
> JavaDoc for Cayenne 3.0 link in the menu shows Cayenne Documentation 3.0-SNAPSHOT API
> --------------------------------------------------------------------------------------
>
> Key: CAY-1501
> URL: https://issues.apache.org/jira/browse/CAY-1501
> Project: Cayenne
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 3.0.1
> Reporter: Borut Bolcina
>
> There should be 3.0.1 API version, not the 3.0-SNAPSHOT API when accessed from the menu on the official site.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.