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

Adding a document for installing Athens on ACI #967

Merged
merged 1 commit into from
Feb 21, 2019

Conversation

arschles
Copy link
Member

@arschles arschles commented Dec 6, 2018

What is the problem I am trying to address?

There were no docs on how to install Athens on Azure Container Instances

How is the fix applied?

I added a document describing how to install Athens on Azure Container Instances

Mention the issue number it fixes or add the details of the changes if it doesn't have a specific issue.

Fixes #57

@arschles arschles added the docs improvements/changes to our documentation label Dec 6, 2018
@arschles arschles requested a review from a team as a code owner December 6, 2018 21:45
@codecov-io
Copy link

codecov-io commented Dec 6, 2018

Codecov Report

Merging #967 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #967   +/-   ##
=======================================
  Coverage   54.83%   54.83%           
=======================================
  Files          79       79           
  Lines        2639     2639           
=======================================
  Hits         1447     1447           
  Misses       1073     1073           
  Partials      119      119

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3525cda...39c8475. Read the comment docs.

Copy link
Member

@michalpristas michalpristas left a comment

Choose a reason for hiding this comment

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

LGTM 💯


## Selecting a Storage Provider

Athens currently supports a number of storage drivers. For quick and easy use on ACI, we recommend using the local disk provider. For more permanend use, we recommend using MongoDB or other more persistent infrastructure. For other providers, please see the [storage provider documentation](/configuration/storage/).
Copy link
Member

Choose a reason for hiding this comment

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

s/permanend/permanent


### Installing with the MongoDB Storage Driver

First make sure you have the following environment variable set up:
Copy link
Member

Choose a reason for hiding this comment

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

s/First make/First, make

@@ -10,7 +10,7 @@ We will use Docker to run the Athens proxy, so first make sure you have Docker [

## Selecting a Storage Provider

Athens currently supports a number of storage drivers. For local use we recommend starting with the local disk provider. For other providers, please see the Storage Provider documentation [Coming Soon].
Athens currently supports a number of storage drivers. For local use we recommend starting with the local disk provider. For other providers, please see the [storage provider documentation](/configuration/storage/).
Copy link
Member

Choose a reason for hiding this comment

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

s/For local use we recommend/For local use, we recommend
but not sure about that

Copy link
Member Author

Choose a reason for hiding this comment

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

sounds better to me with the comma too 👍

@michalpristas michalpristas merged commit 280d9f3 into gomods:master Feb 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs improvements/changes to our documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs on how to deploy Athens to ACI
3 participants