-
Notifications
You must be signed in to change notification settings - Fork 183
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
Documentation: Official Docker Image #43
Conversation
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.
This is a great start, thank you so much for contributing this Khalian. I'm going to take a knife to the README, if you don't mind, since we need it to be a bit more general purpose.
@@ -0,0 +1,7 @@ | |||
Copyright (C) 2015 by Haris Amin |
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.
2017 – Copyright attribution should perhaps be "Swiftdocker maintainers"? @hamin ?
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.
I would let you guys decide on what exact string should be here.
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.
@swizzlr I've seen some other projects have a Contributors.MD with he list of the contributors. But Yeah I'm cool with "Swiftdocker maintainers/contributors"
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.
Done.
@@ -0,0 +1 @@ | |||
An Ubuntu docker image containing the latest version of swift. |
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.
Since this description is really meant to be more about the product itself, perhaps we could steal the following from the official swift website:
Swift is a general-purpose programming language built using a modern approach to safety, performance, and software design patterns.
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.
Needs to be less than 100 chars.
Swift is a general-purpose programming language using a modern approach to safety and performance.
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.
Done
##### Create a Container from the Image and Attach It: | ||
|
||
```bash | ||
docker run --privileged -i -t --name swiftfun swift:latest /bin/bash |
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.
Docker won't accept us recommending --privileged. Let's add a note describing the problem. Hopefully someone else might fix it one day (short version: REPL depends on lldb which needs privileged kernel access or something)
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.
Ok so a comment for the same ?
… official docker repository. <Type> : docs
##### Create a Container from the Image and Attach It: | ||
|
||
```bash | ||
docker run --privileged -i -t --name swiftfun swiftdocker/swift:latest /bin/bash |
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.
Any particular reason you're including --privileged
here? That's essentially giving the container full unfettered access to your host, so definitely not recommended. 😅
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.
I plagiarized the README from the project.
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.
It's a bug with Swift - only required if you need a REPL, which is an uncommon requirement anyway so we'll remove it. I'll improve this today and submit @tianon
Official PR docker-library/docs#794 |
: docs