[
https://issues.apache.org/jira/browse/GEODE-7260?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16942245#comment-16942245
]
Joey McAllister commented on GEODE-7260:
----------------------------------------
That's a great catch, Alberto. I agree that that is unclear and should be
corrected, but I think the correction should be to change the wording in the
README, rather than following the current wording by publishing documentation
that does not yet have a release associated with it. Doing that would create a
lot of maintenance (and potential for breakage) between the website and the
documentation.
If we agreed to publish pre-release documentation to the website, that would
require anyone who ever made a change to the documentation to manually push to
the website. (Updating the website is a manual activity.) If they forgot or
just didn't do it, then the pre-release docs on the website would fall behind
the actual pre-release docs.
Currently, anyone can build the pre-release documentation locally and, so long
as they have pulled all the latest check-ins from the repo, they can be sure
that they're seeing the latest documentation. This is similar to how the code
part of the product works, and I think it makes sense to keep it that way.
I definitely think we should more clearly state in the geode-book README that
what is built and published to the website ("latest") is the documentation for
the most recent release, rather than unfinished documentation (which is still
available to build locally). What do you think about that as a fix?
> Publish latest version of documentation in web
> ----------------------------------------------
>
> Key: GEODE-7260
> URL: https://issues.apache.org/jira/browse/GEODE-7260
> Project: Geode
> Issue Type: Improvement
> Components: docs
> Reporter: Alberto Bustamante Reyes
> Priority: Major
>
> Following sentence is stated in [README file of
> geode-book|https://github.com/apache/geode/tree/develop/geode-book] :
> {code}
> The latest check-ins to {geode-project-dir}/geode-docs on the develop branch
> are regularly built and published to http://geode.apache.org/docs/.
> {code}
> Currently in the web page there are only links to the documentation of
> official releases.
> I think it would be useful to publish the latest version of documentation.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
