This repository was archived by the owner on Dec 7, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 51
Fix typos, broken links, grammar #421
Open
lauzadis
wants to merge
2
commits into
HackIllinois:staging
Choose a base branch
from
lauzadis:feat/auth-docs
base: staging
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,10 +11,10 @@ This repository contains the code which runs the backend services supporting Hac | |
| 5. [Documentation](#documentation) | ||
|
|
||
| ## Developer Environment Setup | ||
| In order to work on the API there are a few setups neccessary in order to setup your developer environemnt. | ||
| In order to work on the API there are a few steps neccessary in order to setup your developer environemnt. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Typo: neccessary -> necessary |
||
|
|
||
| ### Installing Dependencies | ||
| We highly reccommend that you use Ubuntu 18.04 when working on API development. The API is written and Go and makes use of MongoDB for storing data. You will have to install both of these before working on the API. You will also need a few common development tools including `make` and `git`. | ||
| We highly reccommend that you use Ubuntu when working on API development. The API is written in Go and makes use of MongoDB for storing data. You will have to install both of these before working on the API. You will also need a few common development tools including `make` and `git`. | ||
|
|
||
| #### Installing Development Tools | ||
| Both `make` and `git` can be installed from the default ubuntu package repositories. Run the following commands to install both tools. You may need to run the commands under `sudo`. | ||
|
|
@@ -30,7 +30,7 @@ Follow the [Go Installation Instructions](https://golang.org/doc/install#install | |
| Follow the [MongoDB Installation Instructions](https://docs.mongodb.com/manual/installation/#mongodb-community-edition) for installing MongoDB. Once MongoDB is installed ensure `mongod` is running. If it is not running then start the service. | ||
|
|
||
| #### Downloading the API source and dependencies | ||
| Run the following command to retrieve the API and all it's dependencies. The API source will be cloned to a folder called `api` in your current directory. | ||
| Run the following command to retrieve the API and all its dependencies. The API source will be cloned to a folder called `api` in your current directory. | ||
| ``` | ||
| git clone https://github.com/HackIllinois/api.git | ||
| ``` | ||
|
|
@@ -72,13 +72,13 @@ make run | |
| There are also `make` targets provided for building a containerized version of the API for usage in production deployments. | ||
|
|
||
| ### Building the API Container | ||
| Building a container requires that docker and go have already been installed. The following command should be run from the root of the api repository. | ||
| Building a container requires that Docker and Go have already been installed. The following command should be run from the root of the API repository. | ||
| ``` | ||
| make container | ||
| ``` | ||
|
|
||
| ### Running the API Container | ||
| You can obtain all released versions and the latest version of the container from [DockerHub](https://hub.docker.com/r/hackillinois/api). The API container takes the name of the service to run as it's command arguement in the following docker run command. Ensure that the correct environment variables are set to load the configuration file and overwrite any secret configuration variables. | ||
| You can obtain all released versions and the latest version of the container from [DockerHub](https://hub.docker.com/r/hackillinois/api). The API container takes the name of the service to run as its command argument in the following `docker run` command. Ensure that the correct environment variables are set to load the configuration file and overwrite any secret configuration variables. | ||
| ``` | ||
| docker run -d --env-file env.config hackillinois/api:latest <servicename> | ||
| ``` | ||
|
|
||
2 changes: 1 addition & 1 deletion
2
documentation/docs/reference/api-writers/documentation-system.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: appropiate -> appropriate