AMBARI-23456. Fix typos.

apache · Jan 4, 2019 · f5074e7 · f5074e7
1 parent 1deed01
commit f5074e7
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -12,14 +12,14 @@ Log aggregation, analysis, and visualization for Ambari managed (or any other) s
 
 - Parse / aggregate and ship logs
 - Send and index logs in Solr
-- Store logs (structured or un-sructured format) in Cloud Storage (S3 / GCS / ADLS / WASB)
-- Fultext Search in logs (if the logs are shipped to Solr)
+- Store logs (structured or unstructured format) in Cloud Storage (S3 / GCS / ADLS / WASB)
+- Full-text Search in logs (if the logs are shipped to Solr)
 - JWT/SSO support
 - Support testing the log parsing on the UI
 
 ## Architecture
 
-- Log Feeder: agent component on all hosts to monitor and shipping logs.
+- Log Feeder: agent component on all hosts to monitor and ship logs.
 - Log Search Portal: REST API + UI for rendering logs
 - Solr (Optional - default): storage for logs, used by both Log Search Portal and Log Feeder
 - ZooKeeper (Optional - default): configuration service for Solr, Log Search and Log Feeder
@@ -29,7 +29,7 @@ Log aggregation, analysis, and visualization for Ambari managed (or any other) s
 
 ## Contents
 
-- [1, Installation](docs/installation.md)
+- [1. Installation](docs/installation.md)
 - [2. Collections](docs/collections.md)
 - [3. Adding new logs to monitor](docs/add_new_input.md) 
 - [4. Development guide](docs/development.md)

diff --git a/docs/development.md b/docs/development.md
@@ -15,7 +15,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 -->
 
-## Developement guide
+## Development guide
 
 ## Requirements
 
@@ -32,7 +32,7 @@ limitations under the License.
 
 ### Build and start Log Search in docker container
 ```bash
-# to see available commands: run start-logsearch without arguments
+# to see available commands: run logsearch-docker without arguments
 cd docker
 ./logsearch-docker build-and-run # build mvn project locally, build docker image, start containers
 ```
@@ -83,7 +83,7 @@ First you need to start every required service (except logfeeder), go to `ambari
 docker-compose up -d zookeeper solr logsearch
 ```
 
-Secondly, if you are planning to run Log Feeder from an IDE, for running the LogFeeder main methoud, you will need to set the working directory to `ambari/ambari-logsearch/ambari-logsearch-logfeeder` or set `LOGFEEDER_RELATIVE_LOCATION` env variable.
+Secondly, if you are planning to run Log Feeder from an IDE, for running the LogFeeder main method, you will need to set the working directory to `ambari/ambari-logsearch/ambari-logsearch-logfeeder` or set `LOGFEEDER_RELATIVE_LOCATION` env variable.
 With Maven, you won't need these steps, just run this command from the ambari-logsearch-logfeeder folder:
 
 ```bash
@@ -114,16 +114,16 @@ make deb
 
 ### Running Integration Tests
 
-By default integration tests are not a part of the build process, you need to set -Dbackend-tests or -Dselenium-tests (or you can use -Dall-tests to run both). To running the tests you will need docker here as well (right now docker-for-mac and unix are supported by default, for boot2docker you need to pass -Ddocker.host parameter to the build).
+By default integration tests are not a part of the build process, you need to set -Dbackend-tests or -Dselenium-tests (or you can use -Dall-tests to run both). For running the tests you will need docker here as well (right now docker-for-mac and unix are supported by default, for boot2docker you need to pass -Ddocker.host parameter to the build).
 
 ```bash
 # from ambari-logsearch folder
 mvn clean integration-test -Dbackend-tests failsafe:verify
-# or run selenium tests with docker for mac, but before that you nedd to start xquartz
+# or run selenium tests with docker for mac, but before that you need to start xquartz
 open -a XQuartz
 # then in an another window you can start ui tests
 mvn clean integration-test -Dselenium-tests failsafe:verify
-# you can specify story file folde location with -Dbackend.stories.location and -Dui.stories.location (absolute file path) in the commands
+# you can specify the folder that contains the story files with -Dbackend.stories.location and -Dui.stories.location (absolute file path) in the commands
 ```
 Also you can run from the IDE, but make sure all of the ambari logsearch modules are built.
 

diff --git a/docs/index.md b/docs/index.md
@@ -22,14 +22,14 @@ Log aggregation, analysis, and visualization for Ambari managed (or any other) s
 
 - Parse / aggregate and ship logs
 - Send and index logs in Solr
-- Store logs (structured or un-sructured format) in Cloud Storage (S3 / GCS / ADLS / WASB)
-- Fultext Search in logs (if the logs are shipped to Solr)
+- Store logs (structured or unstructured format) in Cloud Storage (S3 / GCS / ADLS / WASB)
+- Full-text Search in logs (if the logs are shipped to Solr)
 - JWT/SSO support
 - Support testing the log parsing on the UI
 
 ## Architecture
 
-- Log Feeder: agent component on all hosts to monitor and shipping logs.
+- Log Feeder: agent component on all hosts to monitor and ship logs.
 - Log Search Portal: REST API + UI for rendering logs
 - Solr (Optional - default): storage for logs, used by both Log Search Portal and Log Feeder
 - ZooKeeper (Optional - default): configuration service for Solr, Log Search and Log Feeder
@@ -39,7 +39,7 @@ Log aggregation, analysis, and visualization for Ambari managed (or any other) s
 
 ## Contents
 
-- [1, Installation](installation.md)
+- [1. Installation](installation.md)
 - [2. Collections](collections.md)
 - [3. Adding new logs to monitor](add_new_input.md) 
 - [4. Development guide](development.md)