title | description | tags | authorGithubAlias | authorName | date | |||||
---|---|---|---|---|---|---|---|---|---|---|
Title highlighting the core problem being solved |
Two or three sentences describing the problem, the solution, and tools or services used along the way |
|
githubAliasWithoutQuotes |
Name Surname (no quotes around) |
YYYY-MM-DD (expected publication date) |
EVERYTHING BELOW GETS REPLACED WITH YOUR CONTENT ONCE YOU'VE UPDATED THE FRONTMATTER ABOVE
All frontmatter must be in syntactically correct YAML.
title
- the title of your post in quotes, less than 100 characters i.e. "What Happens When You Type a URL Into Your Browser" - Please put this inside double-quotesdescription
- a description of your post used to surface a short description on the site and for SEO, less than 250 characters - Please put this inside double-quotestags
- help readers discover posts on the same topics. Usekebab-case
.authorGithubAlias
- your GitHub usernameauthorName
- how you want your name to display for the author credit of this postdate
- date this post is published inYYYY-MM-DD
format. This does not effect when your post goes live and is purely for display purposes.
Introduction paragraph to the topic. Describe a real world example to illustrate the problem the reader is facing. Explain why it's a problem. Offer the solution you'll be laying out in this post.
- Bullet list
- with what you will
- learn in this tutorial
Before starting this tutorial, you will need the following:
- All the standard prerequisites should be in the attribute table below, only use this section if you have detailed setup instructions.
Attributes | |
---|---|
✅ AWS Level | Intermediate - 200 |
⏱ Time to complete | 15 minutes |
💰 Cost to complete | Free when using the AWS Free Tier or USD 1.01 |
🧩 Prerequisites | - AWS Account - CodeCatalyst Account - If you have more than one requirement, add it here using the <br> html tag |
💻 Code Sample | Code sample used in tutorial on GitHub |
📢 Feedback | Any feedback, issues, or just a 👍 / 👎 ? |
⏰ Last Updated | YYYY-MM-DD |
ToC |
---|
From here onwards, split the tutorial into logical sections with a descriptive title. Focus titles on the core action steps in each section.
Avoid starting and ending the code blocks with blank lines/spaces. Remember to include the language type used when creating code blocks. ```javascript
.
For example,
this is javascript code
If you want to share a code sample file with reader, then you have two options:
- paste the contents with code blocks like mentioned above
- provide link to the file. Use the raw file content option on GitHub (without the token parameter, if repo is private while drafting). It should look like:
https://raw.githubusercontent.com/ORGANIZATION/REPO-NAME/main/FOLDER/FILENAME.EXTENSION
Example: You can also copy-paste contents of this file from here.
Provide steps to clean up everything provisioned in this tutorial.
Provide a conclusion paragraph that reiterates what has been accomplished in this tutorial (e.g. turning on versioning), and what its value is for the reader (e.g. protecting against loss of work). If it makes sense, tie this back to the problem you described in the introduction, showing how it could be solved in a real-world situation.
Identify natural next steps for curious readers, and suggest two or three useful articles based on those next steps.
Also end with this line to ask for feedback: If you enjoyed this tutorial, found any issues, or have feedback for us, please send it our way!