You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by ma...@apache.org on 2018/04/03 21:06:56 UTC

[34/50] [abbrv] logging-log4j-scala git commit: Add links to docs

Add links to docs


Project: http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/commit/cead3895
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/tree/cead3895
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/diff/cead3895

Branch: refs/heads/master
Commit: cead389503f2314d7c047a62566c3d1eaa798950
Parents: 7e2426b
Author: Matt Sicker <bo...@gmail.com>
Authored: Sat Mar 31 20:25:54 2018 -0500
Committer: Matt Sicker <bo...@gmail.com>
Committed: Sat Mar 31 20:28:09 2018 -0500

----------------------------------------------------------------------
 BUILDING.md     | 14 +-------------
 CONTRIBUTING.md | 53 +---------------------------------------------------
 README.md       |  2 +-
 3 files changed, 3 insertions(+), 66 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/blob/cead3895/BUILDING.md
----------------------------------------------------------------------
diff --git a/BUILDING.md b/BUILDING.md
index 7497179..1fea4bb 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -15,17 +15,5 @@
  limitations under the License.
 -->
 # Building Log4j 2 Scala API
-  
-To build Log4j 2 Scala API, you need a JDK implementation version 1.8 or greater and Apache Maven 3.x.
 
-To perform the license release audit, a.k.a. "RAT check", run.
-
-    mvn apache-rat:check
-
-To install the jars in your local Maven repository, from a command line, run:
-
-    mvn clean install
-
-Next, to build the site:
-
-    mvn site
+Moved to [site docs](./src/asciidoctor/build.adoc).

http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/blob/cead3895/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 526d871..93299c1 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -14,57 +14,6 @@
  See the License for the specific language governing permissions and
  limitations under the License.
 -->
-<!--
-This looks like it was generated, but it was actually modified from the
-CONTRIBUTING.md file from Apache Commons Lang.
--->
 # Contributing to Apache Log4j 2
 
-You have found a bug or you have an idea for a cool new feature? Contributing code is a great way to give something back to
-the open source community. Before you dig right into the code there are a few guidelines that we need contributors to
-follow so that we can have a chance of keeping on top of things.
-
-## Getting Started
-
-+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
-+ Make sure you have a [GitHub account](https://github.com/signup/free).
-+ If you're planning to implement a new feature it makes sense to discuss your changes on the [dev list](https://logging.apache.org/log4j/2.x/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache Log4j's scope.
-+ Submit a ticket for your issue, assuming one does not already exist.
-  + Clearly describe the issue including steps to reproduce when it is a bug.
-  + Make sure you fill in the earliest version that you know has the issue.
-+ Fork the repository on GitHub.
-
-## Making Changes
-
-+ Create a topic branch from where you want to base your work (this is usually the master branch).
-+ Make commits of logical units.
-+ Respect the original code style:
-  + Only use spaces for indentation.
-  + Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
-  + Check for unnecessary whitespace with git diff --check before committing.
-+ Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue.
-+ Make sure you have added the necessary tests for your changes.
-+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
-
-## Making Trivial Changes
-
-For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA.
-In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number.
-
-## Submitting Changes
-
-+ Sign the [Contributor License Agreement][cla] if you haven't already.
-+ Push your changes to a topic branch in your fork of the repository.
-+ Submit a pull request to the repository in the apache organization.
-+ Update your JIRA ticket and include a link to the pull request in the ticket.
-
-## Additional Resources
-
-+ [Project Guidelines](https://logging.apache.org/log4j/2.x/guidelines.html)
-+ [Code Style Guide](https://logging.apache.org/log4j/2.x/javastyle.html)
-+ [Apache Log4j 2 JIRA project page](https://issues.apache.org/jira/browse/LOG4J2)
-+ [Contributor License Agreement][cla]
-+ [General GitHub documentation](https://help.github.com/)
-+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
-
-[cla]:https://www.apache.org/licenses/#clas
+Moved to [site docs](./src/asciidoctor/contributing.adoc).

http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/blob/cead3895/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 7206b3c..f2c2918 100644
--- a/README.md
+++ b/README.md
@@ -86,4 +86,4 @@ mvn install
 
 ## Contributing
 
-We love contributions! Take a look at [our contributing page](https://github.com/apache/logging-log4j-scala/blob/master/CONTRIBUTING.md).
+We love contributions! Take a look at [our contributing page](https://github.com/apache/logging-log4j-scala/blob/master/src/asciidoctor/contributing.adoc).