You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 4, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15-6Lines changed: 15 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,19 +19,28 @@ reported the issue. Please try to include as much information as you can. Detail
19
19
* Any modifications you've made relevant to the bug
20
20
* Anything unusual about your environment or deployment
21
21
22
-
23
22
## Contributing via Pull Requests
24
-
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
23
+
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that you are working against the latest source on the `dev` branch.
24
+
25
+
### Run project locally
26
+
The static website is built using Hugo and to run it locally you need to install the [Hugo CLI](https://gohugo.io/getting-started/installing/).
27
+
28
+
1. Clone this repository.
29
+
2. Switch to the _dev_ branch. (`git checkout dev`).
30
+
3. Download the Learn theme by running `git clone https://github.com/matcornic/hugo-theme-learn.git workshop/themes/learn` from within the root of the project.
31
+
4. Run `hugo serve` from within the _workshop_ folder.
32
+
33
+
Please keep in mind the following before sending a pull request.
25
34
26
-
1. You are working against the latest source on the *master* branch.
27
-
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
28
-
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
35
+
- You are working against the latest source on the `dev` branch.
36
+
- You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
37
+
- You open an issue to discuss any significant work - we would hate for your time to be wasted.
29
38
30
39
To send us a pull request, please:
31
40
32
41
1. Fork the repository.
33
42
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
34
-
3. Ensure local tests pass.
43
+
3. Ensure you test locally using Hugo CLI.
35
44
4. Commit to your fork using clear commit messages.
36
45
5. Send us a pull request, answering any default questions in the pull request interface.
37
46
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
I’m open source! If you see an issue, want to contribute content, or have overall feedback please open an issue or pull request in our GitHub repository: [github.com/aws-samples/aws-serverless-cicd-workshop](https://github.com/aws-samples/aws-serverless-cicd-workshop).
15
+
16
+
17
+
{{% button href="https://github.com/aws-samples/aws-serverless-cicd-workshop/issues" icon="fas fa-bug" %}}Report an issue{{% /button %}}
Copy file name to clipboardExpand all lines: workshop/content/setup/_index.en.md
+16-11Lines changed: 16 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,23 +8,28 @@ pre = "<b>0. </b>"
8
8
9
9
# Setup
10
10
11
-
### Login to the AWS Workshop Portal
11
+
### AWS Account
12
12
13
-
You should have received a **Participant Hash** that will grant you access to a temporary AWS account. Navigate to the following link to claim your temporary account:
In order to complete this workshop, you’ll need access to an AWS account. Your access needs to have sufficient permissions to create resources in IAM, CloudFormation, API Gateway, CodeCommit, CodePipeline, CodeBuild, CodeDeploy and S3. If you currently don't have an AWS account, you can create one here: [https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account).
[AWS Cloud9](https://aws.amazon.com/cloud9/) is a cloud-based integrated development environment (IDE) that lets you write, run, and debug code from any machine with just a browser. We recommend using it to run this workshop because it already comes with the necessary set of tools pre-installed, but the workshop is not dependent on it, so you are free to run it from your local computer as well.
If you prefer to run the workshop from your local computer without using Cloud9, make sure you install the following tools which are available for Linux, MacOS and Windows.
*[Docker Desktop](https://www.docker.com/products/docker-desktop) - Required to simulate the Lambda runtime locally.
30
+
*[SAM CLI v0.31.0+](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) - To run functions locally and package/deploy SAM apps.
31
+
*[AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) - To create resources in your AWS account.
32
+
*[Git Client](https://git-scm.com/downloads) - To interact with the CodeCommit repository by pushing code changes.
33
+
*[NodeJS and npm](https://www.npmjs.com/get-npm) - The sample app you will create is NodeJs-based.
34
+
35
+
Once you have installed all requirements, you can start the workshop here: [Start workshop](/sam.html).
You should have received a **Participant Hash** that will grant you access to a temporary AWS account. Navigate to the following link to claim your temporary account:
0 commit comments