strongbox · thecodingdoc1 · Jun 5, 2019 · Jun 6, 2019 · Jun 6, 2019 · Jun 6, 2019
diff --git a/docs/developer-guide/add-logging.md b/docs/developer-guide/add-logging.md
@@ -10,7 +10,7 @@ The logging in the application is set up using:
 
 ### Configuration
 
-If you have `strongbox-commons` as a (direct, or transitive) dependency of your module, you will be able to use the logging, without having to specify the dependencies yourself. If, for one reason, or another, you do not want to have this dependency, you will need the following dependencies instead:
+If you have `strongbox-commons` as a (direct or transitive) dependency of your module, you will be able to use the logging, without having to specify the dependencies yourself. If, for one reason or another, you do not want to have this dependency, you will need the following dependencies instead:
 
 ```xml
 <!-- Logging -->
@@ -56,7 +56,7 @@ In order to exclude them as transitive dependencies, you will need to have somet
 
 ## Logging Configuration File Location
 
-The logging is controlled via the [strongbox/strongbox-resources/strongbox-common-resources/src/main/resources/logback.xml]. 
+The logging is controlled via the [strongbox/strongbox-resources/strongbox-common-resources/src/main/resources/logbac-spring.xml]. 
 This resource should be copied wherever necessary using:
 
 ```xml
@@ -94,9 +94,9 @@ This resource should be copied wherever necessary using:
 
 The logging can be configured via the REST API. We have created a separate project called [logback-configuration] for this purpose.  
 
-For details on how to configure the logging and resolve the log files via the REST API, please visit the rest documentation
+For details on how to configure the logging and resolve the log files via the REST API, please visit the REST documentation
 in your Strongbox instance at `http://localhost:48080/docs/rest/api.html`.
 
 
 [logback-configuration]: https://github.com/carlspring/logback-configuration
-[strongbox/strongbox-resources/strongbox-common-resources/src/main/resources/logback.xml]: https://github.com/strongbox/strongbox/blob/master/strongbox-resources/strongbox-common-resources/src/main/resources/logback.xml
+[strongbox/strongbox-resources/strongbox-common-resources/src/main/resources/logback.xml]: https://github.com/strongbox/strongbox/blob/master/strongbox-resources/strongbox-common-resources/src/main/resources/logback-spring.xml
diff --git a/docs/developer-guide/building-strongbox-against-strongbox.md b/docs/developer-guide/building-strongbox-against-strongbox.md
@@ -0,0 +1,169 @@
+# Building Strongbox against Strongbox
+
+We like our dog food and we try it all the time! :smiley:
+
+There will be many cases where you need to test things against either a full-blown Strongbox (via `strongbox-distribution`)
+or the `strongbox-web-core`. The following article shows you how to do so.
+
+## Pre-requisites
+
+You will need to use the following Maven settings file (that we've called `settings-strongbox-localhost` and placed under `~/.m2/settings-strongbox-localhost`):
+
+```
+<?xml version="1.0" encoding="UTF-8"?>
+<settings>
+
+    <mirrors>
+        <mirror>
+            <id>strongbox</id>
+            <name>strongbox</name>
+            <url>http://localhost:48080/storages/public/public-group/</url>
+            <mirrorOf>*</mirrorOf>
+        </mirror>
+    </mirrors>
+
+    <profiles>
+        <profile>
+            <id>carlspring-repositories</id>
+
+            <activation>
+                <activeByDefault>true</activeByDefault>
+            </activation>
+
+            <repositories>
+                <repository>
+                    <id>strongbox</id>
+                    <name>strongbox</name>
+                    <url>http://localhost:48080/storages/public/public-group/</url>
+                    <layout>default</layout>
+                </repository>
+            </repositories>
+            <pluginRepositories>
+                <pluginRepository>
+                    <id>strongbox</id>
+                    <name>strongbox</name>
+                    <url>http://localhost:48080/storages/public/public-group/</url>
+                    <layout>default</layout>
+                </pluginRepository>
+            </pluginRepositories>
+        </profile>
+    </profiles>
+
+    <servers>
+        <server>
+           <id>releases</id>
+           <username>admin</username>
+           <password>password</password>
+        </server>
+        <server>
+           <id>snapshots</id>
+           <username>admin</username>
+           <password>password</password>
+        </server>
+    </servers>
+</settings>
+```
+
+This settings file will ensure that all required artifacts, plugins and extensions are resolved via the running instance of Strongbox. In addition, it will override Maven Central as a fallback repository, so everything required will indeed 
+be resolved through `http://localhost:48080/storages/public/public-group/` which is a group repository that includes 
+all the hosted repositories in Strongbox, as well as all defined proxy repositories.
+
+## Building Strongbox Against The `strongbox-web-core`
+
+1. Clone and build the `strongbox` project (either with `mvn clean install`, or `mvn clean install -DskipTests`, based on your needs)
+2. In the `strongbox-web-core` module, execute the following in order to start Strongbox inside a Jetty instance waiting for connections:
+   ```
+   mvn clean install spring-boot:run
+   ```
+3. In a separately checked out `strongbox` project execute:
+```
+carlspring@carlspring:/java/strongbox> mvn -s ~/.m2/settings-strongbox-localhost.xml -Dmaven.repo.local=.m2/repository clean deploy -DaltDeploymentRepository=snapshots::default::http://localhost:48080/storages/storage0/snapshots/ -DskipTests -fn
+...
+[INFO] --- maven-install-plugin:2.4:install (default-install) @ strongbox-masterbuild ---
+[INFO] Installing /java/strongbox/pom.xml to /java/strongbox/.m2/repository/org/carlspring/strongbox/strongbox-masterbuild/1.0-SNAPSHOT/strongbox-masterbuild-1.0-SNAPSHOT.pom
+[INFO] 
+[INFO] --- maven-deploy-plugin:2.7:deploy (default-deploy) @ strongbox-masterbuild ---
+[INFO] Using alternate deployment repository snapshots::default::http://localhost:48080/storages/storage0/snapshots/
+Downloading: http://localhost:48080/storages/storage0/snapshots/org/carlspring/strongbox/strongbox-masterbuild/1.0-SNAPSHOT/maven-metadata.xml
+Uploading: http://localhost:48080/storages/storage0/snapshots/org/carlspring/strongbox/strongbox-masterbuild/1.0-SNAPSHOT/strongbox-masterbuild-1.0-20180128.060409-1.pom
+Uploaded: http://localhost:48080/storages/storage0/snapshots/org/carlspring/strongbox/strongbox-masterbuild/1.0-SNAPSHOT/strongbox-masterbuild-1.0-20180128.060409-1.pom (4 KB at 5.6 KB/sec)
+Downloading: http://localhost:48080/storages/storage0/snapshots/org/carlspring/strongbox/strongbox-masterbuild/maven-metadata.xml
+Uploading: http://localhost:48080/storages/storage0/snapshots/org/carlspring/strongbox/strongbox-masterbuild/1.0-SNAPSHOT/maven-metadata.xml
+Uploaded: http://localhost:48080/storages/storage0/snapshots/org/carlspring/strongbox/strongbox-masterbuild/1.0-SNAPSHOT/maven-metadata.xml (618 B at 1.2 KB/sec)
+Uploading: http://localhost:48080/storages/storage0/snapshots/org/carlspring/strongbox/strongbox-masterbuild/maven-metadata.xml
+Uploaded: http://localhost:48080/storages/storage0/snapshots/org/carlspring/strongbox/strongbox-masterbuild/maven-metadata.xml (303 B at 0.6 KB/sec)
+[INFO] ------------------------------------------------------------------------
+[INFO] Reactor Summary:
+[INFO] 
+[INFO] Strongbox: Parent .................................. SUCCESS [01:03 min]
+[INFO] Strongbox: Resources [Common] ...................... SUCCESS [01:59 min]
+[INFO] Strongbox: Resources [Storage API] ................. SUCCESS [  4.608 s]
+[INFO] Strongbox: Resources [Web] ......................... SUCCESS [ 25.098 s]
+[INFO] Strongbox: Resources ............................... SUCCESS [  1.816 s]
+...
+[INFO] ------------------------------------------------------------------------
+[INFO] BUILD SUCCESS
+[INFO] ------------------------------------------------------------------------
+[INFO] Total time: 13:37 min
+[INFO] Finished at: 2018-01-28T06:04:10+00:00
+[INFO] Final Memory: 125M/1133M
+[INFO] ------------------------------------------------------------------------
+```
+
+## Building Strongbox Against A Full-blown Strongbox (`strongbox-distribution`)
+1. Build `strongbox` like this:
+   ```
+   mvn clean install -DskipTests
+   ```
+2. Go inside `./strongbox-distribution`:
+   ```
+   cd strongbox-distribution/target
+   ```
+3. Extract the distribution archive:
+   ```
+   tar -zxf *gz
+   ```
+4. Start Strongbox:
+   ```
+   cd strongbox-distribution-*/strongbox-*/
+   ./bin/strongbox console
+   ```
+5. Build the `strongbox` project against the running Strongbox instance:
+```
+$ mvn clean deploy \
+      -s ~/.m2/settings-strongbox-localhost.xml \
+      -Dmaven.repo.local=.m2/repository \
+      -DaltDeploymentRepository=snapshots::default::http://localhost:48080/storages/storage0/snapshots/ \
+      -DskipTests \
+      -fn
+...
+[INFO] --- maven-install-plugin:2.4:install (default-install) @ strongbox-masterbuild ---
+[INFO] Installing /java/strongbox/pom.xml to /java/strongbox/.m2/repository/org/carlspring/strongbox/strongbox-masterbuild/1.0-SNAPSHOT/strongbox-masterbuild-1.0-SNAPSHOT.pom
+[INFO] 
+[INFO] --- maven-deploy-plugin:2.7:deploy (default-deploy) @ strongbox-masterbuild ---
+[INFO] Using alternate deployment repository snapshots::default::http://localhost:48080/storages/storage0/snapshots/
+Downloading: http://localhost:48080/storages/storage0/snapshots/org/carlspring/strongbox/strongbox-masterbuild/1.0-SNAPSHOT/maven-metadata.xml
+Uploading: http://localhost:48080/storages/storage0/snapshots/org/carlspring/strongbox/strongbox-masterbuild/1.0-SNAPSHOT/strongbox-masterbuild-1.0-20180128.060409-1.pom
+Uploaded: http://localhost:48080/storages/storage0/snapshots/org/carlspring/strongbox/strongbox-masterbuild/1.0-SNAPSHOT/strongbox-masterbuild-1.0-20180128.060409-1.pom (4 KB at 5.6 KB/sec)
+Downloading: http://localhost:48080/storages/storage0/snapshots/org/carlspring/strongbox/strongbox-masterbuild/maven-metadata.xml
+Uploading: http://localhost:48080/storages/storage0/snapshots/org/carlspring/strongbox/strongbox-masterbuild/1.0-SNAPSHOT/maven-metadata.xml
+Uploaded: http://localhost:48080/storages/storage0/snapshots/org/carlspring/strongbox/strongbox-masterbuild/1.0-SNAPSHOT/maven-metadata.xml (618 B at 1.2 KB/sec)
+Uploading: http://localhost:48080/storages/storage0/snapshots/org/carlspring/strongbox/strongbox-masterbuild/maven-metadata.xml
+Uploaded: http://localhost:48080/storages/storage0/snapshots/org/carlspring/strongbox/strongbox-masterbuild/maven-metadata.xml (303 B at 0.6 KB/sec)
+[INFO] ------------------------------------------------------------------------
+[INFO] Reactor Summary:
+[INFO] 
+[INFO] Strongbox: Parent .................................. SUCCESS [01:03 min]
+[INFO] Strongbox: Resources [Common] ...................... SUCCESS [01:59 min]
+[INFO] Strongbox: Resources [Storage API] ................. SUCCESS [  4.608 s]
+[INFO] Strongbox: Resources [Web] ......................... SUCCESS [ 25.098 s]
+[INFO] Strongbox: Resources ............................... SUCCESS [  1.816 s]
+...
+[INFO] ------------------------------------------------------------------------
+[INFO] BUILD SUCCESS
+[INFO] ------------------------------------------------------------------------
+[INFO] Total time: 13:37 min
+[INFO] Finished at: 2018-01-28T06:04:10+00:00
+[INFO] Final Memory: 125M/1133M
+[INFO] ------------------------------------------------------------------------
+```
diff --git a/docs/developer-guide/building-the-code-with-docker.md b/docs/developer-guide/building-the-code-with-docker.md
@@ -3,17 +3,17 @@
 ## Introduction
 
 Docker is awesome and we are using it to build and test almost everything. 
-It has proven to be quite fast and convenient way to easily reproduce issues.
-We encourage you to have a decent version of Docker installed on your machine 
+It has proven to be quite a fast and convenient way to easily reproduce issues.
+We encourage you to have a recent version of Docker installed on your machine 
 so that you can debug or reproduce issues easier.
 
-You should note that we are mostly using Linux so this guide is more focused on how to do things on Linux distributions.
+You should note that we are mostly using Linux, so this guide is more focused on how to do things on Linux distributions.
 However, things under Windows shouldn't be that different.
 
 ## Docker installation
 
-Depending on your OS and distribution you can install different versions of Docker CE (Community Edition).
-In most cases your distribution will have it's own package of Docker which works fine. 
+Depending on your OS and distribution, you can install different versions of Docker CE (Community Edition).
+In most cases, your distribution will have its own package of Docker which works fine. 
 
 Please head to the docker [installation manual](https://docs.docker.com/install/) pages to check how to install it on your machine:
 
@@ -127,7 +127,7 @@ This might take a while, but in the end you should have a successful build.
 
 ## Making life easier
 
-If you have already checked out our [strongboxci/alpine] repository you would have noticed the amount of 
+If you have already checked out our [strongboxci/alpine] repository you would have noticed the number of 
 different images we have. Trying to remember all of them and the way you need to setup the container is tedious and 
 unnecessary. We have created a [.bashrc]({{resources}}/docker/bashrc-strongbox) with commands you can execute to easily 
 get a container up and running
@@ -137,7 +137,7 @@ Our `.bashrc` has two types of commands which:
 1. Start a container by mounting the current working directory as `workspace` (i.e `dockerMvn35`, `dockerGradle45`, etc)
 2. Start a container and automatically clone a project from github and use that as the `workspace`. (i.e. `dockerMvn35Checkout`, `dockerGradle45Checkout`, etc) 
 
-If you don't remember arguments the command needs you can always execute `dockerMvn35 --help` and it will print them to you as well as an example.
+If you don't remember arguments the command needs, you can always execute `dockerMvn35 --help` and it will print them to you as well as an example.
 
 ### Setting up `~/.bashrc`
 
@@ -151,7 +151,7 @@ echo "\$HOME/.bashrc-strongbox" >> ~/.bashrc
 ```
 
 You can now either open up a new terminal or execute `source ~/.bashrc`  
-Have fun building things in docker :smile:
+Have fun building things in docker! :smile:
 
 
 ### Example commands
@@ -166,7 +166,7 @@ Have fun building things in docker :smile:
     dockerMvn35Checkout strongbox master/branch/PR-1234 "mvn clean install"
     ```
 
-* Use current working directory to build project
+* Use the current working directory to build the project
     ```
     cd /some/path
     dockerMvn35

diff --git a/docs/developer-guide/building-the-code.md b/docs/developer-guide/building-the-code.md
@@ -80,7 +80,7 @@ Then please make sure that:
 
 * You don't have any other test in progress (e.g. halted by debugger process)
 
-The reason for this failure is that OrientDB can't start, if another OrientDB process is running an listening on the same port.
+The reason for this failure is that OrientDB can't start, if another OrientDB process is running and listening on the same port.
 
 ### Filename too long (Windows 7 and 10)
 
@@ -99,7 +99,7 @@ If you are getting one of these errors:
 
 
 Then you are likely hitting a well-known issue with long paths under Windows. 
-Executing command below should fix the issue:
+Executing the command below should fix the issue:
 
 ```
 git config --system core.longpaths true

diff --git a/docs/developer-guide/coding-convention.md b/docs/developer-guide/coding-convention.md
@@ -3,7 +3,7 @@
 ## Reasoning
 
 It is important to have consistency across the codebase. This won't necessarily make your code work better, but it might 
-help make it more understandable, time-consuming and less irritating to go through when doing a code review of your changes.  
+help make it more understandable, time-consuming, and less irritating to go through when doing a code review of your changes.  
 
 While to some this will seem like a nuisance, with no real benefit to the actual code, and while we do understand 
 this point of view, we think that reading `diff`-s should be quick and easy. Accepting a pull request requires for it to
@@ -62,18 +62,18 @@ and whether, or not it will impact something else. All of this takes time, which
         ```
 
 * When re-indenting code, please make a single commit with just the indentation changes and make sure you describe that 
-  this is just an re-indentation change in the commit message. Mixing reformatting and actual functional changes in the 
+  this is just a re-indentation change in the commit message. Mixing reformatting and actual functional changes in the 
   same commit makes things much more obscure to track and figure out.
 
 * Don't reformat entire files, unless absolutely necessary! This makes it harder (and more time-consuming) to check what 
   changes you've actually made.
 
-* Try not to re-order code imports. Sometimes, while optimizing imports this is not possible, but re-ordering a long 
+* Try not to re-order code imports. Sometimes, while optimizing imports, this is not possible, but re-ordering a long 
   list of imports can make a diff hard to read.
 
 ## Code Example
 
-Please, consider the following an example of how to indent your code.
+Please consider the following an example of how to indent your code.
 
 ??? success "Example class with proper formatting"