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

Documentation: Official Docker Image #43

Merged
merged 5 commits into from
Jan 7, 2017
Merged

Documentation: Official Docker Image #43

merged 5 commits into from
Jan 7, 2017

Conversation

Khalian
Copy link
Contributor

@Khalian Khalian commented Dec 30, 2016

: docs

@Khalian Khalian mentioned this pull request Dec 30, 2016
3 tasks
@Khalian
Copy link
Contributor Author

Khalian commented Dec 30, 2016

#40

Copy link
Contributor

@swizzlr swizzlr left a 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
Copy link
Contributor

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 ?

Copy link
Contributor Author

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.

Copy link
Contributor

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"

Copy link
Contributor Author

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.
Copy link
Contributor

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.

https://swift.org/about/

Copy link
Contributor

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.

Copy link
Contributor Author

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
Copy link
Contributor

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)

Copy link
Contributor Author

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 ?

@swizzlr swizzlr mentioned this pull request Dec 31, 2016
17 tasks
@swizzlr
Copy link
Contributor

swizzlr commented Dec 31, 2016

Wooooo docker-library/official-images#2500

@swizzlr swizzlr changed the title <Description> : Adding documentation for this repository to become an official docker repository. Documentation: Official Docker Image Dec 31, 2016
##### Create a Container from the Image and Attach It:

```bash
docker run --privileged -i -t --name swiftfun swiftdocker/swift:latest /bin/bash
Copy link

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. 😅

Copy link
Contributor Author

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.

Copy link
Contributor

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

@swizzlr swizzlr merged commit 8d3d6b8 into swiftlang:master Jan 7, 2017
@swizzlr
Copy link
Contributor

swizzlr commented Jan 7, 2017

Official PR docker-library/docs#794

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.

4 participants