Skip to content

Commit 823f2d9

Browse files
authored
Merge pull request #13 from blackboard/feature/userDocumentation
Layout updates.
2 parents fe42c4b + 218932b commit 823f2d9

File tree

4 files changed

+32
-9
lines changed

4 files changed

+32
-9
lines changed

docs/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
11
# lambda-selenium [![Build Status](https://travis-ci.org/blackboard/lambda-selenium.svg?branch=master)](https://travis-ci.org/blackboard/lambda-selenium)
22

3-
## [Java Tutorial](./java-tutorial.md)
3+
4+
## Getting Started
5+
1. Download Latest Zip
6+
2. Upload to AWS Lambda
7+
3. Test the Function
8+
9+
### [Beginner: Node Tutorial](./node-tutorial.md)
10+
11+
12+
### [Advanced: Java Tutorial](./java-tutorial.md)
13+

docs/_config.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
theme: jekyll-theme-slate
1+
theme: jekyll-theme-slate
2+
show_downloads: true

docs/java-tutorial.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
* Upload the release zip into an s3 bucket and copy the link for the file.
66
* Create a new Lambda Function in AWS with the following name
77

8-
Note: for the tests to execute this name is required
98
```shell
109
lambda-selenium-function
1110
```
11+
_Note: for the tests to execute this name is required_
1212

13-
* Change the settings of the Lambda Function
13+
**_Change the settings of the Lambda Function_**
1414
1. Set the Runtime to Java 8
1515
2. Set the Handler to com.blackboard.testing.lambda.LambdaTestHandler::handleRequest
1616
3. Set the Memory to 1536 MB
@@ -23,25 +23,25 @@ Note: S3 is required because of the size of the package.
2323

2424
Now the function is ready to be invoked.
2525

26-
* Clone the repository and cd into the java example
26+
**_Use shell commands to clone the repository and change the working directory to the Java example_**
2727
```shell
2828
git clone [email protected]:blackboard/lambda-selenium.git
2929
cd lambda-selenium/lambda-selenium-java/
3030
```
3131

32-
* Run the parameterized test suite ExampleTestSuite using an IDE or from the command line with:
32+
**_Next, run the test suite 'ExampleTestSuite' inside the same shell :_**
3333
```shell
3434
gradle clean test
3535
```
3636

3737
When the tests are ran, they will be executed in parallel by invoking the Lambda function that was created.
38-
Once the tests are complete, open up the build/screenshots folder to view screenshots taken inside the running tests.
39-
If a test fails, the exception will be thrown for the parameterized test case and logged to the console.
38+
Once the tests are complete, open folder './build/screenshots' to view screenshots taken inside the running tests.
39+
If a test fails, the exception will be thrown for the test case and logged to the console.
4040

4141

4242
#### Packaging A New Function
4343

44-
To package the jar, run the following command inside the lambda-selenium-java directory
44+
**_To package the jar, run the following command inside the lambda-selenium-java directory_**
4545
```shell
4646
gradle clean unzipLibs shadowJar
4747
```

docs/node-tutorial.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Lambda-Selenium: NodeJS Tutorial [![Build Status](https://travis-ci.org/blackboard/lambda-selenium.svg?branch=master)](https://travis-ci.org/blackboard/lambda-selenium)
2+
3+
[![Basic Tutorial](http://i.imgur.com/7YTMFQp.png)](http://video.webmfiles.org/big-buck-bunny_trailer.webm "Basic Tutorial")
4+
5+
6+
#### Running The Example
7+
1. [Download the latest release - node_lambda_function.zip](https://github.com/blackboard/lambda-selenium/releases/latest)
8+
2. Create new function in AWS console
9+
3. Add test
10+
4. Try it!
11+
12+

0 commit comments

Comments
 (0)