[jira] [Created] (JEXL-319) Apache project documentation gives instructions in subversion

["David Costanzo (Jira)" <ji...@apache.org>]

David Costanzo created JEXL-319:
-----------------------------------

             Summary: Apache project documentation gives instructions in subversion
                 Key: JEXL-319
                 URL: https://issues.apache.org/jira/browse/JEXL-319
             Project: Commons JEXL
          Issue Type: Bug
            Reporter: David Costanzo


The Apache project page for JEXL at [http://commons.apache.org/proper/commons-jexl/] contains many links for getting started with the source code, none of which work because they all give instructions for Subversion.  These should rewritten in terms of git, be replaced with a link to the github project (which has an up-to-date contributor's guide), or simply be removed.

 

*Places to Update*

1) The instructions on [http://commons.apache.org/proper/commons-jexl/source-repository.html] are written for subversion and (fortunately) don't work at all.

2) [http://commons.apache.org/proper/commons-jexl/issue-tracking.html] includes a sentence

> For more information on subversion and creating patches see the [Apache Contributors Guide|http://www.apache.org/dev/contributors.html].

The contribute guide is also written for subversion and an Apache-hosted git.  This should be removed or replaced with a reference to [https://github.com/apache/commons-jexl/blob/master/CONTRIBUTING.md]

3)  There's a helpfully-named file that's committed into Subversion

[https://svn.apache.org/repos/asf/commons/proper/jexl/JEXLnowUsesGit.txt]

However, the content is misleading, as it says to go to [http://commons.apache.org/jexl/source-repository.html] (see #1 above).   It also says

 
{noformat}
The SVN tree has been moved to:
https://svn.apache.org/repos/asf/commons/_moved_to_git/jexl 
{noformat}
However, this looks like a stale copy of the source code from GitHub.  It might be better to direct people to GitHub.

4) On [http://commons.apache.org/proper/commons-jexl/building.html] there's a sentence

> The source is [here|http://svn.apache.org/repos/asf/commons/proper/jexl/trunk/].

However, that link returns a 404 not found.

5) On [http://commons.apache.org/proper/commons-jexl/integration.html] it says that the project uses Jenkins, but I couldn't find it in the given link.  (It might be there, but I was under the impression that GitHub has its own CI system).

 

*Impact:*

I have a few bugs to report on JEXL.  Before reporting a bug, I usually try to see if it's still reproducible in the trunk, instead of just the latest release.  I typed "jexl" in a search engine and it took me to the project page.  None of the instructions I found to get that source code worked and even the place-holder that said it had moved to hit didn't help.  Eventually, I found my way to this Jira, which led me to some active bugs, which led me to a pull request, which led me to the GitHub.  All in all, this only took a few hours, but it's a few hours that could have been saved if the project documentation pointed me straight to GitHub.

 



--
This message was sent by Atlassian Jira
(v8.3.4#803005)