-
Notifications
You must be signed in to change notification settings - Fork 880
/
example-readme-template.md.txt
93 lines (53 loc) · 4.19 KB
/
example-readme-template.md.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<!--
Use this template as a quick starting point when writing a README for your Pulumi example. To start, copy this file to your example folder and rename it to `README.md`. Once you've reviewed the template, delete the comments and begin writing your accompanying README for your example Pulumi application.
Use GitHub's "Preview Changes" functionality to make sure everything is formatted correctly in Markdown.
Readers should be able to follow your example from beginning to end. Please be sure to list all prerequisites, and test your guide from start to finish. Cut and paste commands from the README into your terminal to make sure there aren't typos or inaccuracies. If you find yourself executing a command that isn't in the README, make sure to add it so the readers end up with a complete tutorial. See [EC2 Linux WebServer Instance](https://www.pulumi.com/docs/tutorials/aws/ec2-webserver/) for an example of a tutorial following this template. Note that the featured tutorial is multi-language whereas the exampleas in this repo are cloud and language-specific (except for the ones with the `cloud` prefix).
-->
# [App Description] using [Service or Tool]
<!-- Use Title Case for all Titles -->
<!-- Most of the examples are transformed into tutorials on https://www.pulumi.com/docs/tutorials/ and are sorted by cloud and language. There is no need to include the cloud provider name or the language in the title.
<!-- Our examples have a specific structure. Learn more at CONTRIBUTING.md -->
Introductory paragraph about the example that explains what problem it solves and why the reader should care. If possible, include use cases.
In this tutorial, we will [configure/set up/build/deploy] [some thing]...
When you're finished, you'll be able to...
## Prerequisites
<!-- The Prerequisites section includes an ordered list of required installation and configuration steps before the reader can deploy the Pulumi example. -->
1. [Install Pulumi](https://www.pulumi.com/docs/get-started/install/)
1. Configure [cloud] <!-- We have setup pages for our popular cloud providers at https://www.pulumi.com/docs/intro/cloud-providers/<cloud-provider>/setup/ -->
1. Install [language runtime] <!-- We have setup pages for our supported language runtimes at https://www.pulumi.com/docs/intro/languages/<language>/ -->
1. (Optional) List any other accounts needed, such as Twitter, Slack, or other services.
<!-- Example:
1. [Install Pulumi](https://www.pulumi.com/docs/get-started/install/)
1. [Configure your AWS Credentials](https://www.pulumi.com/docs/intro/cloud-providers/aws/setup/)
1. [Install Node.js](https://www.pulumi.com/docs/intro/languages/javascript/)
-->
## Deploy the App
### Step 1: Create a directory and cd into it
For Pulumi examples, we typically start by creating a directory and changing into it. Then, we create a new Pulumi project from a template. For example, `azure-javascript`.
First....
Next...
Finally...
<!--
If showing a command, explain the command first by talking about what it does. Then show the command and its output. If the output is too long, you can clip it with `...` and only show the relevant parts. If your README includes images, make sure to include an alt text.
Now transition to the next step by telling the reader what's next. If you're adding to a file, make sure to clearly explain that.
-->
### Step 2: Sentence case
Another introduction
Your content
Transition to the next step.
### Step 3
Another introduction
Your content
Transition to the next step.
## Clean Up
<!--We generally ask the reader to run `pulumi destroy` and tear down the resources to avoid incurring any costs. -->
## Summary
In this tutorial, you [configured/set up/built/deployed] [something]. Now you can....
<!-- Give a quick recap of what the readers have learned and optionally provide places for further exploration. -->
## Next Steps
<!-- Optionally include an unordered list of relevant Pulumi tutorials. -->
<!-- Example:
- [Create a load-balanced, hosted NGINX container service](https://www.pulumi.com/docs/tutorials/aws/ecs-fargate/)
- [Create an EC2-based WebServer and associated infrastructure](https://www.pulumi.com/docs/tutorials/aws/ec2-webserver/)
-->