[ 
https://issues.apache.org/jira/browse/CALCITE-1937?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16453443#comment-16453443
 ] 

ASF GitHub Bot commented on CALCITE-1937:
-----------------------------------------

Github user F21 commented on a diff in the pull request:

    https://github.com/apache/calcite-avatica/pull/43#discussion_r184261016
  
    --- Diff: site/develop/index.md ---
    @@ -23,115 +23,9 @@ limitations under the License.
     
     Want to help add a feature or fix a bug?
     
    -* TOC
    -{:toc}
    +Please find the development guides for Avatica's components here:
     
    -## Source code
    -
    -You can get the source code by
    -[downloading a release]({{ site.baseurl }}/downloads)
    -or from source control.
    -
    -Calcite uses git for version control.  The canonical source is in
    -[Apache](https://git-wip-us.apache.org/repos/asf/calcite.git),
    -but most people find the
    -[Github mirror](https://github.com/apache/calcite-avatica) more
    -user-friendly.
    -
    -## Download source, build, and run tests
    -
    -Prerequisites are git, maven (3.2.1 or later) and Java (JDK 1.7 or
    -later, 1.8 preferred) on your path.
    -
    -Create a local copy of the git repository, `cd` to its root directory,
    -then build using maven:
    -
    -{% highlight bash %}
    -$ git clone git://github.com/apache/calcite-avatica.git avatica
    -$ cd avatica
    -$ mvn install
    -{% endhighlight %}
    -
    -The HOWTO describes how to
    -[build from a source distribution]({{ site.baseurl 
}}/docs/howto.html#building-from-a-source-distribution),
    -[run more or fewer tests]({{ site.baseurl 
}}/docs/howto.html#running-tests) and
    -[run integration tests]({{ site.baseurl 
}}/docs/howto.html#running-integration-tests).
    -
    -### Disabling protobuf generation
    -
    -On older operating systems, developers trying to build Avatica may 
experience
    -issues with the Xolstice maven-protobuf-plugin, similar to the following:
    -
    -```
    -[INFO] Compiling 3 proto file(s) to /avatica/core/src/main/java
    -[ERROR] PROTOC FAILED: 
/avatica/core/target/protoc-plugins/protoc-3.1.0-linux-x86_64.exe: 
/lib64/libc.so.6: version `GLIBC_2.14' not found (required by 
/avatica/core/target/protoc-plugins/protoc-3.1.0-linux-x86_64.exe)
    -[ERROR] /avatica/core/src/main/protobuf/common.proto [0:0]: 
/avatica/core/target/protoc-plugins/protoc-3.1.0-linux-x86_64.exe: 
/lib64/libc.so.6: version `GLIBC_2.14' not found (required by 
/avatica/core/target/protoc-plugins/protoc-3.1.0-linux-x86_64.exe)
    -[ERROR] /avatica/core/src/main/protobuf/responses.proto [0:0]: 
/avatica/core/target/protoc-plugins/protoc-3.1.0-linux-x86_64.exe: 
/lib64/libc.so.6: version `GLIBC_2.14' not found (required by 
/avatica/core/target/protoc-plugins/protoc-3.1.0-linux-x86_64.exe)
    -[ERROR] /avatica/core/src/main/protobuf/requests.proto [0:0]: 
/avatica/core/target/protoc-plugins/protoc-3.1.0-linux-x86_64.exe: 
/lib64/libc.so.6: version `GLIBC_2.14' not found (required by 
/avatica/core/target/protoc-plugins/protoc-3.1.0-linux-x86_64.exe)
    -```
    -
    -In most cases, it is unnecessary to re-generate the Protobuf messages into 
Java code. Developers
    -can side-step this issue by disabling the `compile-protobuf` profile in 
their Maven execution.
    -
    -{% highlight bash %}
    -$ mvn package -P!compile-protobuf
    -{% endhighlight %}
    -
    -
    -## Contributing
    -
    -We welcome contributions.
    -
    -If you are planning to make a large contribution, talk to us first! It
    -helps to agree on the general approach. Log a
    -[JIRA case](https://issues.apache.org/jira/browse/CALCITE) for your
    -proposed feature or start a discussion on the dev list.
    -
    -Fork the github repository, and create a branch for your feature.
    -
    -Develop your feature and test cases, and make sure that
    -`mvn install` succeeds. (Run extra tests if your change warrants it.)
    -
    -Commit your change to your branch, and use a comment that starts with
    -the JIRA case number, like this:
    -
    -{% highlight text %}
    -[CALCITE-345] AssertionError in RexToLixTranslator comparing to date 
literal
    -{% endhighlight %}
    -
    -If your change had multiple commits, use `git rebase -i master` to
    -squash them into a single commit, and to bring your code up to date
    -with the latest on the main line.
    -
    -Then push your commit(s) to github, and create a pull request from
    -your branch to the calcite master branch. Update the JIRA case
    -to reference your pull request, and a committer will review your
    -changes.
    -
    -## Continuous Integration Testing
    -
    -Calcite has a collection of Jenkins jobs on ASF-hosted infrastructure.
    -They are all organized in a single view and available at
    
-[https://builds.apache.org/view/A-D/view/Calcite-Avatica/](https://builds.apache.org/view/A-D/view/Calcite-Avatica/).
    -
    -## Getting started
    -
    -Calcite is a community, so the first step to joining the project is to 
introduce yourself.
    -Join the [developers 
list](http://mail-archives.apache.org/mod_mbox/calcite-dev/)
    -and send an email.
    -
    -If you have the chance to attend a 
[meetup](http://www.meetup.com/Apache-Calcite/),
    -or meet [members of the 
community](http://calcite.apache.org/develop/#project-members)
    -at a conference, that's also great.
    -
    -Choose an initial task to work on. It should be something really simple,
    -such as a bug fix or a [Jira task that we have labeled
    
-"newbie"](https://issues.apache.org/jira/issues/?jql=labels%20%3D%20newbie%20%26%20project%20%3D%20Calcite%20%26%20status%20%3D%20Open).
    -Follow the [contributing guidelines](#contributing) to get your change 
committed.
    -
    -After you have made several useful contributions we may
    -[invite you to become a 
committer](https://community.apache.org/contributors/).
    -We value all contributions that help to build a vibrant community, not 
just code.
    -You can contribute by testing the code, helping verify a release,
    -writing documentation or the web site,
    -or just by answering questions on the list.
    +Component         | Guide
    +:---------------- | :-----------------------------------
    +Avatica           | [Development Guide](avatica.html)
    +Avatica Go Client | [Development Guide](avatica-go.html)
    --- End diff --
    
    `{{ site.baseurl }}/develop/` isn't required for the link to work. However, 
if the coding standards call for it, then we should add it.


> Web site for Avatica Go
> -----------------------
>
>                 Key: CALCITE-1937
>                 URL: https://issues.apache.org/jira/browse/CALCITE-1937
>             Project: Calcite
>          Issue Type: Bug
>          Components: avatica-go
>            Reporter: Julian Hyde
>            Assignee: Francis Chuang
>            Priority: Major
>
> Create a web site for calcite-avatica-go.
> How about this:
> * At run time, the pages should appear under http://calcite.apache.org/avatica
> * The pages should be source-controlled under calcite-avatica-go/site, in 
> markdown format (same as calcite and avatica), and generated into svn using 
> similar trickery to calcite and avatica.
> * Reduce the amount of content in 
> https://github.com/apache/calcite-avatica-go/blob/master/README.md. The 
> "documentation" stuff should move to under http://calcite.apache.org/avatica. 
> So the page will be mainly a re-direct to the Apache home page. Similar to 
> https://github.com/apache/calcite-avatica/blob/master/README.md, in fact.
> * Add a go_history.md file.
> Should avatica-go appear on http://calcite.apache.org/avatica/downloads, or 
> should it have its own download page? I think it probably the former.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to