Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Ubuntu 18.04 and MacOS Mojave image documentation #355

Merged
merged 4 commits into from
Apr 12, 2019

Conversation

shiroyasha
Copy link
Contributor

Several small steps:

  • Remove overview, jump straight to the point
  • Be explicit that this is a Virtual Machine image (not a docker image)
  • Give example usage

@shiroyasha shiroyasha requested a review from markoa April 11, 2019 13:44
- [Apple machine type](#apple-machine-type)

## Overview

A **machine type** specifies a particular collection of virtualized
hardware resources available to a virtual machine (VM) instance,
including the memory size, virtual CPU count, and disk.

This guide describes the available machine types. For using the supported
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's also fix this sentence: For using... -> For instructions about using...

@@ -16,19 +25,35 @@
- [Rust](#Rust)
- [See also](#see-also)

## Overview
The `ubuntu1804` Virtual Machine uses an *APT mirror* that is in the same data
center as our build cluster, which means that caching packages will have little
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/our/Semaphore's

with any [Linux machine type][machine-types] when defining the [agent][agent]
of your pipeline or block.

The `ubuntu1804` is a virtual machine image. The user in the environment, named
Copy link
Contributor

@markoa markoa Apr 11, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose saying "virtual machine (VM)" here, and then using "VM" instead of "virtual machine" in further text.

Copy link
Contributor

@markoa markoa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merge after these minor tweaks.

@shiroyasha shiroyasha merged commit d5939ea into master Apr 12, 2019
@shiroyasha shiroyasha deleted the cd-ci-fixes branch April 12, 2019 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants