From 7d2dad0886808746ca1aa844d569d901957d8a41 Mon Sep 17 00:00:00 2001 From: ahawkins Date: Sun, 30 Nov 2014 19:55:37 +0100 Subject: [PATCH] Add thrift docs --- thrift/README-short.txt | 1 + thrift/README.md | 64 +++++++++++++++++++++++++++++++++++++++++ thrift/content.md | 21 ++++++++++++++ thrift/license.md | 1 + thrift/user-feedback.md | 20 +++++++++++++ update.sh | 1 + 6 files changed, 108 insertions(+) create mode 100644 thrift/README-short.txt create mode 100644 thrift/README.md create mode 100644 thrift/content.md create mode 100644 thrift/license.md create mode 100644 thrift/user-feedback.md diff --git a/thrift/README-short.txt b/thrift/README-short.txt new file mode 100644 index 000000000..8a282dccb --- /dev/null +++ b/thrift/README-short.txt @@ -0,0 +1 @@ +Thrift is a framework for generating client and services from an IDL. diff --git a/thrift/README.md b/thrift/README.md new file mode 100644 index 000000000..b30419a60 --- /dev/null +++ b/thrift/README.md @@ -0,0 +1,64 @@ +# Supported tags and respective `Dockerfile` links + +- [`0.9`, `0.9.2`, `latest` (*0.9/Dockerfile*)](https://github.com/ahawkins/docker-thrift/blob/a44afdab68eaf2a930e46809fac1c0a2d4355908/0.9/Dockerfile) + +For more information about this image and its history, please see the [relevant +manifest file +(`library/thrift`)](https://github.com/docker-library/official-images/blob/master/library/thrift) +in the [`docker-library/official-images` GitHub +repo](https://github.com/docker-library/official-images). + +# What Is Thrift + +> The Apache Thrift software framework, for scalable cross-language +> services development, combines a software stack with a code generation +> engine to build services that work efficiently and seamlessly between +> C++, Java, Python, PHP, Ruby, Erlang, Perl, Haskell, C#, Cocoa, +> JavaScript, Node.js, Smalltalk, OCaml and Delphi and other languages. + +Read more about [Thrift](https://thrift.apache.org). + +# How To Use This Image + +This is image is intended to run as an executable. Files are provided +by mounting a directory. Here's an example of compiling +`service.thrift` to ruby to the current directory. + + docker run -v "$(pwd):/data" thrift thrift -o /data --gen rb /data/service.thrift + +Note, that you may want to include `-u $(id -u)` to set the UID on +generated files. The thrift process runs as root by default which will +generate root owned files depending on your docker setup. + +# License + +View [license information](http://www.apache.org/licenses/) for the software contained in this image. + +# Supported Docker versions + +This image is officially supported on Docker version 1.4.1. + +Support for older versions (down to 1.0) is provided on a best-effort basis. + +# User Feedback + +## Issues + +If you have any problems with or questions about this image, please contact me +through a [GitHub issue](https://github.com/ahawkins/docker-thrift/issues). + +You can also reach many of the official image maintainers via the +`#docker-library` IRC channel on [Freenode](https://freenode.net). + +## Contributing + +You are invited to contribute new features, fixes, or updates, large +or small; I am always thrilled to receive pull requests, and do my +best to process them as fast as I can. + +Before you start to code, I recommend discussing your plans through a +[GitHub issue](https://github.com/ahawkins/docker-thrift/issues), +especially for more ambitious contributions. This gives other +contributors a chance to point you in the right direction, give you +feedback on your design, and help you find out if someone else is +working on the same thing. diff --git a/thrift/content.md b/thrift/content.md new file mode 100644 index 000000000..384fa865b --- /dev/null +++ b/thrift/content.md @@ -0,0 +1,21 @@ +# What Is Thrift + +> The Apache Thrift software framework, for scalable cross-language +> services development, combines a software stack with a code generation +> engine to build services that work efficiently and seamlessly between +> C++, Java, Python, PHP, Ruby, Erlang, Perl, Haskell, C#, Cocoa, +> JavaScript, Node.js, Smalltalk, OCaml and Delphi and other languages. + +Read more about [Thrift](https://thrift.apache.org). + +# How To Use This Image + +This is image is intended to run as an executable. Files are provided +by mounting a directory. Here's an example of compiling +`service.thrift` to ruby to the current directory. + + docker run -v "$(pwd):/data" thrift thrift -o /data --gen rb /data/service.thrift + +Note, that you may want to include `-u $(id -u)` to set the UID on +generated files. The thrift process runs as root by default which will +generate root owned files depending on your docker setup. diff --git a/thrift/license.md b/thrift/license.md new file mode 100644 index 000000000..e4b27dd49 --- /dev/null +++ b/thrift/license.md @@ -0,0 +1 @@ +View [license information](http://www.apache.org/licenses/) for the software contained in this image. diff --git a/thrift/user-feedback.md b/thrift/user-feedback.md new file mode 100644 index 000000000..66c647bb4 --- /dev/null +++ b/thrift/user-feedback.md @@ -0,0 +1,20 @@ +## Issues + +If you have any problems with or questions about this image, please contact me +through a [GitHub issue](https://github.com/ahawkins/docker-thrift/issues). + +You can also reach many of the official image maintainers via the +`#docker-library` IRC channel on [Freenode](https://freenode.net). + +## Contributing + +You are invited to contribute new features, fixes, or updates, large +or small; I am always thrilled to receive pull requests, and do my +best to process them as fast as I can. + +Before you start to code, I recommend discussing your plans through a +[GitHub issue](https://github.com/ahawkins/docker-thrift/issues), +especially for more ambitious contributions. This gives other +contributors a chance to point you in the right direction, give you +feedback on your design, and help you find out if someone else is +working on the same thing. diff --git a/update.sh b/update.sh index 941fd82a9..7a8e64e4b 100755 --- a/update.sh +++ b/update.sh @@ -43,6 +43,7 @@ declare -A otherRepos=( [perl]='https://github.com/Perl/docker-perl' [registry]='https://github.com/docker/docker-registry' [r-base]='https://github.com/rocker-org/rocker' + [thrift]='https://github.com/ahawkins/docker-thrift' [ubuntu-debootstrap]='https://github.com/tianon/docker-brew-ubuntu-debootstrap' [ubuntu-upstart]='https://github.com/tianon/dockerfiles' [ubuntu]='https://github.com/tianon/docker-brew-ubuntu-core'