Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 2.92 KB

assignment.md

File metadata and controls

42 lines (26 loc) · 2.92 KB
Raw

This is a technical writing and editing project as part of your interview.

This project is designed to take between 1.5 - 2 hours. Please take the time to carefully review the writing style guide and the layout guide.

Instructions

Before you start editing, you should set up a working environment and learn about our editing process.

Create a git repository on GitHub, GitLab, Bitbucket, or any other git hosting service.

Read the style guide snippets, which is a subset of our official engineering style guide, and the guide template. Then make improvements to the sample prose, so it embodies the principles in the style guide.

Get started

We recommend you clone the project to your local workstation. Use the Code button on the main project page to retrieve the URL and issue the git clone command on your workstation.

Alternatively, you may download the terraform-getting-started.md file. This file is located in the education-engineer folder. You can also download the entire project as a zip.

Another option is to copy the file content to your local workstation. To view the file content, click on the file terraform-getting-started.md from GitHub. Click on the "Raw" button when viewing the individual file and copy the content. Before editing, commit the initial terraform-getting-started.md file to the repo that you have created for this project.

NOTE: DO NOT FORK THE PROJECT AND SUBMIT A PULL REQUEST TOWARDS THE ORIGINAL PROJECT.

Edit the sample

Now that your environment is set up, you can start to edit the file terraform-getting-started.md on your local machine. Complete the following tasks, make all changes in Markdown.

  • Look for and fix any spelling or grammar issues.
  • Edit the text for readability and compatibility with the style guide.
  • Add the outputs in Markdown for all the commands.
  • Add section titles that are compatible with the guide template.
  • Add learning objectives to the introduction.
  • Add additional sections and content for both prerequisites and next steps.

Assumptions:

  • The audience has none to minimal experience with Terraform.

Submit your sample

  • Commit your changes to the terraform-getting-started.md file and push to the repository.
  • Open a pull request. If you are not familiar with the pull request process, review the documentation for GitHub, GitLab, or Bitbucket.
  • Send the pull request link to your recruiting contact for review. It will be easiest if this is a public repository.