Add Django Documentation

This commit is contained in:
Moghedrin 2014-12-29 17:17:17 -07:00
parent 180fa3a260
commit 164cc29281
6 changed files with 107 additions and 0 deletions

0
django/.keep Normal file
View File

1
django/README-short.txt Normal file
View File

@ -0,0 +1 @@
Django is a free web application framework, written in Python.

72
django/README.md Normal file
View File

@ -0,0 +1,72 @@
# Supported tags and respective `Dockerfile` links
- [`1.7.1-python2`, `1.7-python2`, `1-python2`, `python2` (*2.7/Dockerfile*)](https://github.com/docker-library/django/blob/bb3c2e2bf12906c37330602b70d8b8398bf734b9/2.7/Dockerfile)
- [`python2-onbuild` (*2.7/onbuild/Dockerfile*)](https://github.com/docker-library/django/blob/bb3c2e2bf12906c37330602b70d8b8398bf734b9/2.7/onbuild/Dockerfile)
- [`1.7.1-python3`, `1.7.1`, `1.7-python3`, `1.7`, `1-python3`, `1`, `python3`, `latest` (*3.4/Dockerfile*)](https://github.com/docker-library/django/blob/bb3c2e2bf12906c37330602b70d8b8398bf734b9/3.4/Dockerfile)
- [`python3-onbuild`, `onbuild` (*3.4/onbuild/Dockerfile*)](https://github.com/docker-library/django/blob/bb3c2e2bf12906c37330602b70d8b8398bf734b9/3.4/onbuild/Dockerfile)
For more information about this image and its history, please see the [relevant
manifest file
(`library/django`)](https://github.com/docker-library/official-images/blob/master/library/django)
in the [`docker-library/official-images` GitHub
repo](https://github.com/docker-library/official-images).
# What is Django?
Django is a free and open source web application framework, written in Python,
which follows the model-view-controller architectural pattern. Django's primary
goal is to ease the creation of complex, database-driven websites with an
emphasis on reusability and "pluggability" of components.
> [wikipedia.org/wiki/Django_(web_framework)](https://en.wikipedia.org/wiki/Django_%28web_framework%29)
![logo](https://raw.githubusercontent.com/docker-library/docs/master/django/logo.png)
# How to use this image
## Create a `Dockerfile` in your Django app project
FROM python:onbuild
Put this file in the root of your app, next to the `requirements.txt`.
This image includes multiple `ONBUILD` triggers which should cover most
applications. The build will `COPY . /usr/src/app`, `RUN pip install`,
`EXPOSE 8080`, and set the default command to `python manage.py runserver`.
You can then build and run the Docker image:
docker build -t my-django-app .
docker run --name some-django-app -d my-django-app
You can test it by visiting `http://container-ip:8080` in a browser or, if you
need access outside the host, on `http://localhost:8080` with the following command:
docker run --name some-django-app -p 8080:8080 -d my-django-app
# License
View [license information](https://github.com/django/django/blob/master/LICENSE)
for the software contained in this image.
# User Feedback
## Issues
If you have any problems with or questions about this image, please contact us
through a [GitHub issue](https://github.com/docker-library/django/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;
we are always thrilled to receive pull requests, and do our best to process them
as fast as we can.
Before you start to code, we recommend discussing your plans
through a [GitHub issue](https://github.com/docker-library/django/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.

32
django/content.md Normal file
View File

@ -0,0 +1,32 @@
# What is Django?
Django is a free and open source web application framework, written in Python,
which follows the model-view-controller architectural pattern. Django's primary
goal is to ease the creation of complex, database-driven websites with an
emphasis on reusability and "pluggability" of components.
> [wikipedia.org/wiki/Django_(web_framework)](https://en.wikipedia.org/wiki/Django_%28web_framework%29)
%%LOGO%%
# How to use this image
## Create a `Dockerfile` in your Django app project
FROM python:onbuild
Put this file in the root of your app, next to the `requirements.txt`.
This image includes multiple `ONBUILD` triggers which should cover most
applications. The build will `COPY . /usr/src/app`, `RUN pip install`,
`EXPOSE 8080`, and set the default command to `python manage.py runserver`.
You can then build and run the Docker image:
docker build -t my-django-app .
docker run --name some-django-app -d my-django-app
You can test it by visiting `http://container-ip:8080` in a browser or, if you
need access outside the host, on `http://localhost:8080` with the following command:
docker run --name some-django-app -p 8080:8080 -d my-django-app

2
django/license.md Normal file
View File

@ -0,0 +1,2 @@
View [license information](https://github.com/django/django/blob/master/LICENSE)
for the software contained in this image.

BIN
django/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB