Skip to content

Latest commit

 

History

History
63 lines (48 loc) · 2.3 KB

PROJECT-TEMPLATE.md

File metadata and controls

63 lines (48 loc) · 2.3 KB
Raw

CATEGORYXX-PROVIDERXXX - Project Title

  • ✍️ [Title should be in the form of: CATEGORY01-PROVIDER100 - TITLE]
    • CATEGORY is BIL, SEC, GOV, etc.
    • 01 is the subcategory seen in the main README
    • PROVIDER is AWS, AZ, GCP, OTH(other, please use an abbreviation)
    • 100 is both the level of difficulty as well as a unique ID of the project. (100,101,102 - see already existing projects)
    • TITLE is the title of the project. Be brief but informative.
    • Make sure the filename matches the Title and is in the right folder, fe. Projects/COM/COM03/COM03-AZ200.md

Cloud Service Provider

✍️ [You need to choose a single cloud provider, unless your project is multi-cloud]

  • Microsoft Azure
  • Amazon Web Services
  • Google Cloud

Difficulty

✍️ [You need to choose what level, please delete until one is remaining]

  • Level 100 (Introductory)
  • Level 200 (Intermediate)
  • Level 300 (Advanced)
  • Level 400 (Expert)

Project's Author(s)

✍️ [Provide one contact information per author where participants can reach you in the form of a link. Twitter, Github, LinkedIn, Email etc.]

Objectives

You need to complete the following:

✍️ [Create at least three objectives the participant should complete]

  • Objective 1
  • Objective 2
  • Objective 3

You need to answer the following:

✍️ [Create three or four questions the participant should be able to answer by the end of the project]

References

✍️ [Add any references or links that provide guidance to the project (not 3rd party how-tos)]

Costs

✍️ [Do your best to calculate the overall costs for the project, or if it's included in the free tier.]

  • Included in the Free Tier
  • $1-5 per hour running

Estimated time to complete

✍️ [Do your best to calculate the estimated time it takes to complete the project]

  • 45-60 minutes
  • 2 hours

Tips

✍️ [Provide any gotchas that are crucial to know. ✍️ Provide any possible unexpected charges, or awareness around default expensive options. ✍️ Provide small technical details that would be huge time-sinks. ✍️ If there are none of the above please omit the tips section.]

Misc

  • ❌ Omit this section before creating your idea.
  • ❗️Make sure every section is using bullet points, even if it's only one.