This is an automated email from the ASF dual-hosted git repository.
jbonofre pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/karaf-cave.git
The following commit(s) were added to refs/heads/master by this push:
new fef5df3 Some spelling + grammatical fixes for the manual
new b5f339d Merge pull request #22 from coheigea/manual
fef5df3 is described below
commit fef5df3d2546b78127542371f77fe17417b4948a
Author: Colm O hEigeartaigh <[email protected]>
AuthorDate: Wed Jun 5 13:58:19 2019 +0100
Some spelling + grammatical fixes for the manual
---
manual/src/main/asciidoc/overview.adoc | 10 +++++-----
manual/src/main/asciidoc/user-guide/administrate-cave.adoc | 2 +-
manual/src/main/asciidoc/user-guide/cave-repository.adoc | 4 ++--
manual/src/main/asciidoc/user-guide/deployer.adoc | 6 +++---
manual/src/main/asciidoc/user-guide/features-gateway.adoc | 4 ++--
manual/src/main/asciidoc/user-guide/http-wrapper.adoc | 2 +-
manual/src/main/asciidoc/user-guide/installation.adoc | 8 ++++----
manual/src/main/asciidoc/user-guide/populate-repository.adoc | 8 ++++----
manual/src/main/asciidoc/user-guide/proxy-repository.adoc | 6 +++---
9 files changed, 25 insertions(+), 25 deletions(-)
diff --git a/manual/src/main/asciidoc/overview.adoc
b/manual/src/main/asciidoc/overview.adoc
index c7cc296..aea2254 100644
--- a/manual/src/main/asciidoc/overview.adoc
+++ b/manual/src/main/asciidoc/overview.adoc
@@ -16,7 +16,7 @@
Apache Karaf Cave is an Apache Karaf sub-project.
-Apache Karaf Cave is an implementation an artifact repository and deployment
platform for Apache Karaf supporting:
+Apache Karaf Cave is an implementation of an artifact repository and
deployment platform for Apache Karaf supporting:
* OSGi Repository specification
* Maven Repository manager
@@ -29,15 +29,15 @@ Apache Karaf Cave provides the following features:
* *Storage*: Cave includes a storage backend. The default one is a simple
filesystem backend. As the Cave backend
is designed in a plugin way, you can implement your own backend (for instance,
JDBC or LDAP backend).
-* *Repository Metadata Generation*: Cave creates the repository metadata for
you, using the artifacts presents in the
+* *Repository Metadata Generation*: Cave creates the repository metadata for
you, using the artifacts present in the
repository storage.
* *Maven Repository*: Cave repositories act as a complete Maven repository,
allowing you to use Cave directly with Maven.
* *REST API*: Cave provides a REST API to manipulate the repositories.
-* *Artifact Upload*: Users can upload OSGi bundle in a Cave repository. It
supports URLs like mvn:groupId/artifactId/version,
+* *Artifact Upload*: Users can upload OSGi bundles to a Cave repository. It
supports URLs like mvn:groupId/artifactId/version,
file:, http:, etc.
* *OSGi Repository proxy*: Cave is able to proxy an existing repository, for
instance an existing Maven repository.
The artifacts are located on the "external" repository, Cave handles the
repository metadata. Cave supports file: and http:
URLs, it means that Cave is able to browse a remote HTTP Maven repository for
instance.
* *OSGi Repository population*: Cave is able to get artifacts present on an
"external" repository (local file: or
-remote http:), looking for OSGi bundles, and copy the artifacts in the Cave
repository storage.
-* *Deployer*: Cave Deployer is able to control and deployer applications on a
"farm" of Apache Karaf instances.
+remote http:), looking for OSGi bundles, and copy the artifacts to the Cave
repository storage.
+* *Deployer*: Cave Deployer is able to control and deploy applications on a
"farm" of Apache Karaf instances.
diff --git a/manual/src/main/asciidoc/user-guide/administrate-cave.adoc
b/manual/src/main/asciidoc/user-guide/administrate-cave.adoc
index 432c678..666ceb8 100644
--- a/manual/src/main/asciidoc/user-guide/administrate-cave.adoc
+++ b/manual/src/main/asciidoc/user-guide/administrate-cave.adoc
@@ -24,7 +24,7 @@ This MBean uses the following object name:
org.apache.karaf.cave:type=repository,name=*
----
-Thanks to this MBean, using any JMX client (like jconsole for instance), you
can do all actions as you can using the `cave:*` commands:
+Thanks to this MBean, using any JMX client (like jconsole for instance), you
can do all the same actions as you can using the `cave:*` commands:
* void createRepository(String name, String location, boolean generate,
boolean install) throws Exception;
* void destroyRepository(String name) throws Exception;
diff --git a/manual/src/main/asciidoc/user-guide/cave-repository.adoc
b/manual/src/main/asciidoc/user-guide/cave-repository.adoc
index 4c38e6f..dbabdee 100644
--- a/manual/src/main/asciidoc/user-guide/cave-repository.adoc
+++ b/manual/src/main/asciidoc/user-guide/cave-repository.adoc
@@ -63,14 +63,14 @@ A repository is identified by a name, `my-repository` in
our example.
Apache Karaf Cave creates the repository storage for you.
-If you want to use an existing directory, and avoid Cave to create one in the
storage location, you can use the `-l`
+If you want to use an existing directory, and avoid Cave creating one in the
storage location, you can use the `-l`
('--location') option:
----
karaf@root()> cave:repository-create -l /home/user/.m2/repository m2
----
-By default, Apache Karaf Cave scans the repository storage and create the
repository metadata. You can use the `-no` (`--no-generate`)
+By default, Apache Karaf Cave scans the repository storage and creates the
repository metadata. You can use the `-no` (`--no-generate`)
option to avoid this step:
----
diff --git a/manual/src/main/asciidoc/user-guide/deployer.adoc
b/manual/src/main/asciidoc/user-guide/deployer.adoc
index bbbf13b..7a783b6 100644
--- a/manual/src/main/asciidoc/user-guide/deployer.adoc
+++ b/manual/src/main/asciidoc/user-guide/deployer.adoc
@@ -20,14 +20,14 @@ You have specific commands: `cave:deployer-*`.
==== Connections
-The first component of the deployer is the connection. A connection describe
an access to a Apache Karaf instance.
+The first component of the deployer is the connection. A connection describes
an access to an Apache Karaf instance.
You can create a connection via `cave:deployer-connection-register` command or
the REST Deployer API.
A connection contains:
* an unique name for the connection
-* the JMX URL to the give Apache Karaf instance
+* the JMX URL to the given Apache Karaf instance
* the name of the Apache Karaf instance
* username and password to connect to the Apache Karaf instance
@@ -123,4 +123,4 @@ Apache Karaf Cave Deployer supports:
==== Cellar
-Apache Karaf Cave Deployer supports features handling on a Cellar cluster.
\ No newline at end of file
+Apache Karaf Cave Deployer supports features handling on a Cellar cluster.
diff --git a/manual/src/main/asciidoc/user-guide/features-gateway.adoc
b/manual/src/main/asciidoc/user-guide/features-gateway.adoc
index b32602b..91956e3 100644
--- a/manual/src/main/asciidoc/user-guide/features-gateway.adoc
+++ b/manual/src/main/asciidoc/user-guide/features-gateway.adoc
@@ -25,7 +25,7 @@ The Cave Features Gateway is automatically installed by the
`cave-server` featur
==== Cave Features Gateway server
-You can manipulate the Features Gateway using specific shell commands or
corresponding MBean.
+You can manipulate the Features Gateway using specific shell commands or the
corresponding MBean.
===== Shell commands
@@ -81,4 +81,4 @@ Any Karaf instance can use the gateway using the regular
`feature:repo-add` comm
karaf@root()> feature:repo-add http://cave_server:8181/cave/http/gateway
----
-NB: the Karaf instances use a cache, so you have to flush the changes on the
gateway using the `feature:repo-refresh` command.
\ No newline at end of file
+NB: the Karaf instances use a cache, so you have to flush the changes on the
gateway using the `feature:repo-refresh` command.
diff --git a/manual/src/main/asciidoc/user-guide/http-wrapper.adoc
b/manual/src/main/asciidoc/user-guide/http-wrapper.adoc
index ac64051..9109e83 100644
--- a/manual/src/main/asciidoc/user-guide/http-wrapper.adoc
+++ b/manual/src/main/asciidoc/user-guide/http-wrapper.adoc
@@ -16,7 +16,7 @@
When you install the Apache Karaf Cave Server, it starts a HTTP service
wrapper.
-It means that all artifacts and repository metadata presents in local
repositories are exposed over HTTP.
+It means that all artifacts and repository metadata present in local
repositories are exposed over HTTP.
==== Repository metadata access
diff --git a/manual/src/main/asciidoc/user-guide/installation.adoc
b/manual/src/main/asciidoc/user-guide/installation.adoc
index 07c5d2a..0699d0f 100644
--- a/manual/src/main/asciidoc/user-guide/installation.adoc
+++ b/manual/src/main/asciidoc/user-guide/installation.adoc
@@ -18,10 +18,10 @@ This chapter describes how to install Apache Karaf Cave
into an existing Apache
==== Pre-installation requirements
-As Apache Karaf Cave is a Apache Karaf sub-project, it has to be installed
into a running Apache Karaf instance.
+As Apache Karaf Cave is an Apache Karaf sub-project, it has to be installed
into a running Apache Karaf instance.
Apache Karaf Cave is available as Apache Karaf features. The easiest way to
install is just to have an internet
-connection from the Apache Karaf running instance.
+connection from the running Apache Karaf instance.
Apache Karaf Cave 4.0.x is designed to work on Apache Karaf 4.0.x.
@@ -30,8 +30,8 @@ Apache Karaf Cave 4.0.x is designed to work on Apache Karaf
4.0.x.
Simply register the Apache Karaf Cave features URL in your Apache Karaf
instance:
----
-karaf@root()> feature:repo-add cave
-Adding feature url
mvn:org.apache.karaf.cave/apache-karaf-cave/4.1.1/xml/features
+karaf@root()> feature:repo-add cave 4.1.2
+Adding feature url
mvn:org.apache.karaf.cave/apache-karaf-cave/4.1.2/xml/features
----
==== Starting Apache Karaf Cave
diff --git a/manual/src/main/asciidoc/user-guide/populate-repository.adoc
b/manual/src/main/asciidoc/user-guide/populate-repository.adoc
index 5663966..2e36be9 100644
--- a/manual/src/main/asciidoc/user-guide/populate-repository.adoc
+++ b/manual/src/main/asciidoc/user-guide/populate-repository.adoc
@@ -25,7 +25,7 @@ karaf@root()> cave:repository-upload my-repository
file:/home/user/.m2/repositor
karaf@root()> cave:repository-upload my-repository
http://svn.apache.org/repos/asf/servicemix/m2-repo/org/apache/qpid/qpid-broker/0.8.0/qpid-broker-0.8.0.jar
----
-You can also use Maven style URL:
+You can also use a Maven style URL:
----
karaf@root()> cave:repository-upload my-repository
mvn:org.apache.servicemix.bundles/org.apache.servicemix.bundles.ant/1.7.0_5
@@ -39,8 +39,8 @@ You can also make a kind of "bulk" population of your
repository, using an exter
karaf@root()> cave:repository-populate my-repository
file:/home/user/.m2/repository
----
-Apache Karaf Cave supports `file:` but also `http:` URL. It means that Apache
Karaf Cave is able to browse a remote repository and copy the artifacts
-in your "local" repository.
+Apache Karaf Cave supports `file:` but also `http:` URLs. It means that Apache
Karaf Cave is able to browse a remote repository and copy the artifacts
+to your "local" repository.
For instance, you can populate your repository using all Ant ServiceMix
bundles present on the Central Maven
repository:
@@ -56,7 +56,7 @@ karaf@root()> cave:repository-populate my-repository
http://repo1.maven.org/mave
----
Maven Central repository is really huge and populating from the whole Maven
Central Repository will take
-very very long time. It's just for demonstration purpose.
+a very very long time. It's just for demonstration purposes.
You can filter the artifacts that you want to pick up to populate the
repository. The `cave:repository-populate` command accepts
a regex option for the filter. For instance, to pick up only joda-time version
2 artifact, you can run:
diff --git a/manual/src/main/asciidoc/user-guide/proxy-repository.adoc
b/manual/src/main/asciidoc/user-guide/proxy-repository.adoc
index 4fa1a71..4f5f5b4 100644
--- a/manual/src/main/asciidoc/user-guide/proxy-repository.adoc
+++ b/manual/src/main/asciidoc/user-guide/proxy-repository.adoc
@@ -14,7 +14,7 @@
=== Proxy repository
-As you can populate repository, you can also proxy an "external" repository.
+As you can populate a repository, you can also proxy an "external" repository.
It means that the artifacts stay on the remote repository, Apache Karaf Cave
generates the repository metadata in the local repository
for the remote artifacts:
@@ -34,13 +34,13 @@ have to call the `cave:proxy-repository` command each time
the remote repository
A best practice is to create a Cave repository dedicated for each proxied
repository.
====
-The `cave:repository-proxy` command accepts the filter option, as the
`cave:repository-populate` command:
+The `cave:repository-proxy` command accepts the filter option, like the
`cave:repository-populate` command:
----
karaf@root()> cave:repository-proxy --filter .*joda-time-2.* my-repository
http://repo2.maven.org/maven2/joda-time/joda-time
----
-The `cave:repository-proxy` command accepts the properties option, as the
`cave:repository-populate` command:
+The `cave:repository-proxy` command accepts the properties option, like the
`cave:repository-populate` command:
----
karaf@root()> cave:repository-proxy --properties <properties-file-path>
my-repository <remote-repository-url>
