/content/<Pillar Name>/<lab level>/<content folder for lab>
. For instance, you would put a 100 level performance lab in /content/Performance Efficiency/100_Labs/100_my_new_lab
_index.md
is required in the root folder for your lab, it’s the lab landing page (old README.md) and then each step is its own markdown file, prefaced with the order number. (For example: 1_starthere.md
, 2_do_a_thing.md
, 3_cleanup.md
)./static/(shortpillarname)/(content folder for lab)/code
/static/(shortpillarname)/(content folder for lab)/Images
1000px x 700px
is good, if you use larger images they get scaled & are hard to read>800px
, which stops images from being placed next to text. Create the image border and then resize with whitespace/(content folder for lab)/Images/(your image.png)?classes=lab_picture_small)
When you update a lab picture please ensure it had the following:
>800px
, which stops images from being placed next to text. Create the image border and then resize with whitespaceAn example can be seen below:
Step example :
After making the changes or additions test and verify locally
Navigate back to the aws-well-architected-labs parent folder
Serve the content locally:
hugo serve -D
Open a browser and navigate to http://localhost:1313/
Verify the change you made was correct and no problems were introduced
Push your changes to GitHub, so that they are stored and backed up by GitHub. Use the following commands:
git add -A
git commit -m "your comment here"
git push
Please write a descriptive commit message following this guidance. Smaller meaningful commits are better than one large commit with lots of changes
All your changes will be in the remote repository in GitHub, which can now be merged into the Well-Architected Labs repository.
New labs require an additional validation step of two peer reviews. Please have two peers review your lab step by step to confirm it is working as expected prior to submitting a pull request.