Skip to content

Commit 319bb87

Browse files
author
Ukiah Smith
committed
Getting started updates
- Updated intro copy on MQv3 - minor text tweaks
1 parent e50a736 commit 319bb87

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

mq/3/gettingstarted/index.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,22 @@ title: Getting Started with IronMQ v3
33
layout: default
44
section: mq
55
---
6-
<p>Connect your applications and processes with an elastic message queue. Decouple your processes and create a highly scalable system by passing messages. This example is in Ruby, but can be done in your language of choice. You can find all of our client libraries <a href='http://dev.iron.io/mq/3/libraries'>here</a>/</p>
7-
8-
This is a VERY high level overview of a complex tool.
6+
ronMQ is a enterprise grade message queue; it is highly available, persistent by design, with best-effort one-time delivery. IronMQ ties distributed systems together by providing reliable communication between your services and components.
97

8+
This example is in Ruby, but can be done in your language of choice using one of our <a href='http://dev.iron.io/mq/3/libraries'>client libraries</a>.
109

1110

1211
<h2>Create a Project and Setup Credentials</h2>
1312

14-
Before starting, you'll need to setup a couple of things. You only need to do this once.
13+
Before starting, you will need to setup a couple of things. You only need to do this once.
1514

1615
First, create a project to put this example into.<br>
1716
<img src='https://raw.githubusercontent.com/iron-io/docs/gh-pages/images/newProject.png' style='width: 400px; margin-left: 75;'>
1817

1918
Click the MQ 3 button next to the title to go to the project's dashboard.
2019
<img src='https://raw.githubusercontent.com/iron-io/docs/gh-pages/images/dashButton.png' style='width: 400px; margin-left: 19px;'>
2120

22-
Now lets create a directory on our local computer to hold this project. I'm calling mine mqExample, but yours can be anything you'd like. After it's made, CD into it:
21+
Now lets create a directory on our local computer to hold this project. I am calling mine mqExample, but yours can be anything you would like. After it is made, CD into it:
2322
{% highlight bash %}
2423
$ mkdir mqExample
2524
$ cd mqExample
@@ -33,7 +32,7 @@ $ mv ~/Downloads/iron.json .
3332
{% endhighlight %}
3433

3534

36-
Now, we're all done with the setup process and can get to work.
35+
Now, we are all done with the setup process and can get to work.
3736

3837
<h2>Create a Queue and Add a Message</h2>
3938

@@ -69,16 +68,16 @@ You can click on the queue name to see more information about that queue:
6968
<img src='https://raw.githubusercontent.com/iron-io/docs/gh-pages/images/queueInfo.png' style='width: 400px; margin-left: 75px;'>
7069

7170
<h2>Process/Consume the Messages</h2>
72-
From here, you can work with the queue via the Hud UI, programatically, or the Iron CLI, whichever you prefer. Because I don't need this message for anything, I'll get rid of it with the CLI.
71+
From here, you can work with the queue via the Hud UI, programatically, or the Iron CLI, whichever you prefer. Because I do not need this message for anything, I will get rid of it with the CLI.
7372

74-
If you don't already have the CLI installed, [please click here](/worker/cli/) for installation instructions
73+
If you do not already have the CLI installed, [please click here](/worker/cli/) for installation instructions
7574

76-
We'll be using the pop function. For information on this speific tool as well as all of the other features in the CLI, please refer to their man pages(--help).
75+
We will be using the pop function. For information on this speific tool as well as all of the other features in the CLI, please refer to their man pages(--help).
7776
{% highlight bash %}
7877
$ iron mq pop My_Very_First_Queue
7978
{% endhighlight %}
8079

8180

82-
If you watch the dashboard as you send that command, you'll see the message being removed in the realtime data graph.<br>
81+
If you watch the dashboard as you send that command, you will see the message being removed in the realtime data graph.<br>
8382
<img src='https://raw.githubusercontent.com/iron-io/docs/gh-pages/images/postPop.png' style='width: 400px;'>
8483

worker/getting_started/index.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ IronWorker is a container based distributed work-on-demand platform. We use Dock
88

99
This getting started tutorial will walk you through the steps of writing custom code, testing it locally, deploying it to Iron, and queuing message to run tasks.
1010

11+
<hr style="margin: 3em auto; max-width: 70%">
12+
1113
<p class="subtitle">Offload your tasks to the parallel-processing power of the elastic cloud. Write your code, then queue tasks against it&mdash;no servers to manage, no scaling to worry about.</p>
1214

1315
<div class="flow-steps">
@@ -39,7 +41,7 @@ Before starting, you will need to setup a couple of things. You only need to do
3941

4042
<h2 id="hello">Hello World Worker</h2>
4143

42-
This is a very simple hello world example worker in Ruby. You don't even need Ruby installed to try this example so give it a go!
44+
This is a very simple hello world example worker in Ruby. You do not even need Ruby installed to try this example so give it a go!
4345
All languages follow the same process so you will get an idea of how things work regardless.
4446

4547
<h3 id="write">1. Write your custom Worker code</h3>
@@ -99,7 +101,7 @@ That's it, you have ran a worker on the IronWorker cloud platform!
99101

100102
Now let's get into more detail.
101103

102-
<h3 id="test">2. Write and Test your Worker</h3>
104+
<h3 id="test">2. Test your Worker</h3>
103105

104106
IronWorker's <a href="/worker/reference/environment">environment</a> is a Linux Docker container that your task is executed in. Anything you write that runs inside of our published <a href="https://hub.docker.com/r/iron" target="_blank">Docker images</a> should run just the same as on IronWorker. The key here is getting it to run with the Docker commands below and sample payloads.
105107

@@ -160,7 +162,7 @@ Now you can start queuing jobs or schedule recurring jobs for your image.
160162
iron worker queue --payload-file MY_PAYLOAD.json --wait USERNAME/IMAGENAME
161163
{% endhighlight %}
162164

163-
Notice we don't use the image tag when queuing, this is so you can change versions without having to update all your code that's queuing up jobs for the image.
165+
Notice we do not use the image tag when queuing, this is so you can change versions without having to update all your code that's queuing up jobs for the image.
164166

165167
The --wait parameter waits for the job to finish, then prints the output. You will also see a link to HUD where you can see all the rest of the task details along with the log output.
166168

0 commit comments

Comments
 (0)