Updated Docker Documentation on Readme #188
Closed
Conversation
This file contains 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
ahwagner
requested changes
May 10, 2023
| @@ -48,6 +48,36 @@ gracefully (and without causing problems for others!).** | |||
| The `[extras]` argument tells pip to install packages to fullfill the dependencies of the | |||
| `ga4gh.vrs.extras` package. | |||
|
|
|||
| ## Getting started with Docker | |||
|
|
|||
There was a problem hiding this comment.
This section is good, but should be integrated in the context of why they would want to get started with Docker (answer: because the ga4gh.vrs.extra utils are dependent upon them). I think this README would therefore make sense with a little transition text, in an introductory subsection under "Installing dependencies for ga4gh.vrs.extras" section, below.
.idea/.gitignore
Outdated
There was a problem hiding this comment.
Please remove the .idea directory and content from this PR.
korikuzma
requested changes
May 10, 2023
README.md
Outdated
| @@ -48,6 +48,36 @@ gracefully (and without causing problems for others!).** | |||
| The `[extras]` argument tells pip to install packages to fullfill the dependencies of the | |||
| `ga4gh.vrs.extras` package. | |||
|
|
|||
| ## Getting started with Docker | |||
|
|
|||
| Docker is an open-source platform that enables you to automate the deployment and management of applications using containers. Containers are lightweight, isolated environments that package all the necessary software and dependencies for an application to run consistently across different systems | |||
There was a problem hiding this comment.
Suggested change
| Docker is an open-source platform that enables you to automate the deployment and management of applications using containers. Containers are lightweight, isolated environments that package all the necessary software and dependencies for an application to run consistently across different systems | |
| Docker is an open-source platform that enables you to automate the deployment and management of applications using containers. Containers are lightweight, isolated environments that package all the necessary software and dependencies for an application to run consistently across different systems. |
README.md
Outdated
Comment on lines
55
to
81
| If you're new to Docker, follow these steps to get started: | ||
|
|
||
| ### Step 1: Install Docker | ||
| To begin, you need to install Docker on your machine. Follow the official Docker installation guide for your specific operating system: | ||
|
|
||
| [Docker Installation Guide](https://docs.docker.com/get-docker/) | ||
|
|
||
| ### Step 2: Verify Docker Installation | ||
| Once Docker is installed, you can verify the installation by running the following command in your terminal: | ||
|
|
||
|
|
||
| ``` docker version ``` | ||
|
|
||
| This command displays the Docker client and server versions, indicating that Docker is successfully installed on your machine. | ||
|
|
||
| ### Step 3: Run a Docker Container | ||
| To test Docker, let's run a simple container. In your terminal, execute the following command: | ||
|
|
||
| ``` docker run hello-world ``` | ||
|
|
||
| This command pulls the hello-world Docker image (if not already present) and runs it in a container. You should see a message confirming that Docker is working correctly. | ||
|
|
||
| [Docker Documentation](https://docs.docker.com/) | ||
|
|
||
|
|
||
|
|
||
| ## Installing dependencies for ga4gh.vrs.extras |
There was a problem hiding this comment.
It's probably simpler to just have:
Suggested change
| If you're new to Docker, follow these steps to get started: | |
| ### Step 1: Install Docker | |
| To begin, you need to install Docker on your machine. Follow the official Docker installation guide for your specific operating system: | |
| [Docker Installation Guide](https://docs.docker.com/get-docker/) | |
| ### Step 2: Verify Docker Installation | |
| Once Docker is installed, you can verify the installation by running the following command in your terminal: | |
| ``` docker version ``` | |
| This command displays the Docker client and server versions, indicating that Docker is successfully installed on your machine. | |
| ### Step 3: Run a Docker Container | |
| To test Docker, let's run a simple container. In your terminal, execute the following command: | |
| ``` docker run hello-world ``` | |
| This command pulls the hello-world Docker image (if not already present) and runs it in a container. You should see a message confirming that Docker is working correctly. | |
| [Docker Documentation](https://docs.docker.com/) | |
| ## Installing dependencies for ga4gh.vrs.extras | |
| You will need to install Docker on your machine, follow the official [Docker Installation Guide](https://docs.docker.com/get-docker/) for your specific operating system. | |
| For more information on Docker, see the [Getting Started Guide](https://docs.docker.com/get-started/). | |
| ## Installing dependencies for ga4gh.vrs.extras |
|
last commit fixes it, modified the doc too @ahwagner |
|
This pull request was marked stale due to inactivity. |
korikuzma
requested changes
Jul 11, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Solves Issue #143