Skip to content

Commit

Permalink
Revert "Convert Library references from submodule to upstream (#4102)"
Browse files Browse the repository at this point in the history
This reverts commit 1c5153b.
  • Loading branch information
Misty Stanley-Jones authored Aug 8, 2017
1 parent 1c5153b commit 94826e9
Show file tree
Hide file tree
Showing 145 changed files with 874 additions and 77 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@ _site/**
.sass-cache/**
CNAME
Gemfile.lock
_samples/library/**
4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@
path = tests/src/gopkg.in/yaml.v2
url = https://github.com/go-yaml/yaml.git
branch = a5b47d31c556af34a302ce5d659e6fea44d90de0
[submodule "samples/library"]
path = samples/library
url = https://github.com/docker-library/docs.git
branch = master
25 changes: 25 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Migration

This branch is the result of a migration of documentation from several public and
private repositories. Every attempt has been made to preserve the history of all
content which was migrated from public repositories, so that all public
contributors retain credit for their work, and so that `git log` and
`git blame` commands will work on historical files. At the time of the migration,
over 42,000 public commits already exist in these files, which shows what a
vibrant community the Docker documentation attracts. Thanks to everyone for their
contributions.

The following is a list of each public repository we imported from, the SHA
reference we imported, and its tag if relevant.

| Repository | SHA | Tag |
|----------------------------------------|-----------------|------------------------|
| https://github.com/docker/distribution | a9b1322edf48b1f | docs-v2.5.0-2016-07-28 |
| https://github.com/docker/compose | 429320a4f8f4040 | docs-v1.8.0-2016-08-03 |
| https://github.com/docker/swarm | 27968edd8a160f6 | v1.2.5 |
| https://github.com/docker/notary | a6fda67663e158d | docs-v0.3-2016-08-03 |
| https://github.com/docker/toolbox | c6457341499a196 | docs-v1.12.0-2016-09-16a |
| https://github.com/docker/opensource | b9b87bed67f4289 | docs-2016-08-03 |
| https://github.com/docker/kitematic | 02c9f9607128802 | v0.12.0 |
| https://github.com/docker/machine | 95041b4cfe2e8b2 | docs-v0.8.2-2016-09-28 |
| https://github.com/moby/moby | 3134c23b55eb100 | n/a |
4 changes: 0 additions & 4 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ url: https://docs.docker.com
keep_files: ["v1.4", "v1.5", "v1.6", "v1.7", "v1.8", "v1.9", "v1.10", "v1.11", "v1.12", "v1.13", "v17.03"]
compose_current: 1.14.0

collections:
samples:
output: true

gems:
- jekyll-redirect-from
- jekyll-seo-tag
Expand Down
12 changes: 12 additions & 0 deletions _data/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1260,16 +1260,28 @@ samples:
title: ASP.NET Core + SQL Server on Linux
- path: /engine/examples/couchdb_data_volumes/
title: CouchDB
- path: /samples/couchbase/
title: Couchbase
nosync: true
- path: /compose/django/
title: Django and PostgreSQL
- path: /samples/mongo/
nosync: true
title: MongoDB
- path: /engine/examples/postgresql_service/
title: PostgreSQL
- path: /compose/rails/
title: Rails and PostgreSQL
- path: /samples/redis/
title: Redis
nosync: true
- path: /engine/examples/running_riak_service/
title: Riak
- path: /engine/examples/running_ssh_service/
title: SSHd
- path: /samples/wordpress/
title: WordPress
nosync: true

manuals:
- sectiontitle: Docker Enterprise Edition
Expand Down
4 changes: 2 additions & 2 deletions _includes/generateTOC.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{% if include.tocToGenerate=="library"%}{% for thisPage in site.samples %}
{% if include.tocToGenerate=="library"%}{% for thisPage in site.pages %}{% if thisPage.url contains "/samples/" and thisPage.url != "/samples/" %}
<li><a href="{{ thisPage.url}}"{% if page.url==thisPage.url %}{% assign topicFound="true" %} class="active currentPage"{% endif %}>{{ thisPage.title }}</a></li>
{% endfor %}{% endif %}
{% endif %}{% endfor %}{% endif %}
22 changes: 22 additions & 0 deletions _layouts/library.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
layout: docs
toc_min: 1
noratings: true
---
{% capture fileToUse %}{% if page.file %}{{ page.file }}{% else %}README.md{% endif %}{% endcapture %}
{% capture ghrepo %}{% include_relative library/{{ page.repo }}/github-repo %}{% endcapture %}
{% capture markdowncontent %}
{% include_relative library/{{ page.repo }}/README-short.txt %}

GitHub repo: [{{ ghrepo | strip }}]({{ ghrepo | strip}}){: target="_blank"}

> **Library reference**
>
> This content is imported from
> [the official Docker Library docs](https://github.com/docker-library/docs/tree/master/{{ page.repo}}/),
> and is provided by the original uploader. You can view the Docker Store page for this repo at
> [https://store.docker.com/images/{{ page.repo }}](https://store.docker.com/images/{{ page.repo }}).

{% include_relative library/{{ page.repo }}/{{ fileToUse }} %}
{% endcapture %}
{{ markdowncontent | markdownify }}
8 changes: 0 additions & 8 deletions _samples/boilerplate.txt

This file was deleted.

44 changes: 0 additions & 44 deletions _scripts/fetch-upstream-resources.sh
Original file line number Diff line number Diff line change
Expand Up @@ -18,49 +18,6 @@ svn co https://github.com/docker/docker-ce/"$ENGINE_SVN_BRANCH"/components/cli/d
svn co https://github.com/docker/docker-ce/"$ENGINE_SVN_BRANCH"/components/engine/docs/api md_source/engine/api || (echo "Failed engine/api download" && exit -1) # This will only get you the old API MD files 1.18 through 1.24
svn co https://github.com/docker/distribution/"$DISTRIBUTION_SVN_BRANCH"/docs/spec md_source/registry/spec || (echo "Failed registry/spec download" && exit -1)

# Get the Library docs
svn co https://github.com/docker-library/docs/trunk md_source/_samples/library || (echo "Failed library download" && exit -1)
# Remove symlinks to maintainer.md because they break jekyll and we don't use em
find md_source/_samples/library -maxdepth 9 -type l -delete
# Loop through the README.md files, turn them into rich index.md files
FILES=$(find md_source/_samples/library -type f -name 'README.md')
for f in $FILES
do
curdir=$(dirname "${f}")
justcurdir="${curdir##*/}"
if [ -e ${curdir}/README-short.txt ]
then
# shortrm=$(<${curdir}/README-short.txt)
shortrm=$(cat ${curdir}/README-short.txt)
fi
echo "Adding front-matter to ${f} ..."
echo --- >> ${curdir}/front-matter.txt
echo title: "${justcurdir}" >> ${curdir}/front-matter.txt
echo keywords: library, sample, ${justcurdir} >> ${curdir}/front-matter.txt
echo repo: "${justcurdir}" >> ${curdir}/front-matter.txt
echo layout: docs >> ${curdir}/front-matter.txt
echo permalink: /samples/library/${justcurdir}/ >> ${curdir}/front-matter.txt
echo description: \| >> ${curdir}/front-matter.txt
echo \ \ ${shortrm} >> ${curdir}/front-matter.txt
echo --- >> ${curdir}/front-matter.txt
echo >> ${curdir}/front-matter.txt
echo ${shortrm} >> ${curdir}/front-matter.txt
echo >> ${curdir}/front-matter.txt
if [ -e ${curdir}/github-repo ]
then
# gitrepo=$(<${curdir}/github-repo)
gitrepo=$(cat ${curdir}/github-repo)
echo >> ${curdir}/front-matter.txt
echo GitHub repo: \["${gitrepo}"\]\("${gitrepo}"\)\{: target="_blank"\} >> ${curdir}/front-matter.txt
echo >> ${curdir}/front-matter.txt
fi
cat ${curdir}/front-matter.txt md_source/_samples/boilerplate.txt > ${curdir}/header.txt
echo {% raw %} >> ${curdir}/header.txt
cat ${curdir}/header.txt ${curdir}/README.md > ${curdir}/index.md
echo {% endraw %} >> ${curdir}/index.md
rm -rf ${curdir}/front-matter.txt
rm -rf ${curdir}/header.txt
done

# Get the Engine APIs that are in Swagger
# Be careful with the locations on Github for these
Expand Down Expand Up @@ -90,4 +47,3 @@ wget -O md_source/registry/configuration.md https://raw.githubusercontent.com/do
rm md_source/registry/spec/api.md.tmpl
rm -rf md_source/apidocs/cloud-api-source
rm -rf md_source/tests
rm md_source/_samples/library/index.md
10 changes: 1 addition & 9 deletions metadata.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,4 @@ layout: null
"description":{{ page.description | jsonify }},
"keywords":{{ page.keywords | jsonify }}
}
{% endif %}{% endfor %}
{% for page in site.samples %},
{
"url":{{ page.url | jsonify }},
"title":{{ page.title | jsonify }},
"description":{{ page.description | strip | jsonify }},
"keywords":{{ page.keywords | jsonify }}
}
{% endfor %}]}
{% endif %}{% endfor %}]}
5 changes: 5 additions & 0 deletions redirect_from.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
layout: null
---
{% for page in site.pages %}{% for redirect in page.redirect_from %}{{ redirect }},{{ page.url }}
{% endfor %}{% endfor %}
6 changes: 6 additions & 0 deletions samples/adminer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Adminer
keywords: library, sample, Adminer
layout: library
repo: adminer
---
6 changes: 6 additions & 0 deletions samples/aerospike.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Aerospike
keywords: library, sample, Aerospike
layout: library
repo: aerospike
---
6 changes: 6 additions & 0 deletions samples/alpine.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Alpine
keywords: library, sample, Alpine
layout: library
repo: alpine
---
6 changes: 6 additions & 0 deletions samples/amazonlinux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Amazon Linux
keywords: library, sample, Amazon Linux
layout: library
repo: amazonlinux
---
6 changes: 6 additions & 0 deletions samples/arangodb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: ArangoDB
keywords: library, sample, ArangoDB
layout: library
repo: arangodb
---
6 changes: 6 additions & 0 deletions samples/backdrop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Backdrop
keywords: library, sample, Backdrop
layout: library
repo: backdrop
---
6 changes: 6 additions & 0 deletions samples/bash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Bash
keywords: library, sample, Bash
layout: library
repo: bash
---
6 changes: 6 additions & 0 deletions samples/bonita.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Bonita
keywords: library, sample, Bonita
layout: library
repo: bonita
---
6 changes: 6 additions & 0 deletions samples/buildpack-deps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: buildpack-deps
keywords: library, sample, buildpack-deps
layout: library
repo: buildpack-deps
---
6 changes: 6 additions & 0 deletions samples/busybox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: BusyBox
keywords: library, sample, BusyBox
layout: library
repo: busybox
---
6 changes: 6 additions & 0 deletions samples/cassandra.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Cassandra
keywords: library, sample, Cassandra
layout: library
repo: cassandra
---
6 changes: 6 additions & 0 deletions samples/celery.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Celery
keywords: library, sample, Celery
layout: library
repo: celery
---
6 changes: 6 additions & 0 deletions samples/centos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: CentOS
keywords: library, sample, CentOS
layout: library
repo: centos
---
6 changes: 6 additions & 0 deletions samples/chronograf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Chronograf
keywords: library, sample, Chronograf
layout: library
repo: chronograf
---
6 changes: 6 additions & 0 deletions samples/cirros.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: CirrOS
keywords: library, sample, CirrOS
layout: library
repo: cirros
---
6 changes: 6 additions & 0 deletions samples/clearlinux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Clear Linux
keywords: library, sample, Clear Linux
layout: library
repo: clearlinux
---
6 changes: 6 additions & 0 deletions samples/clojure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Clojure
keywords: library, sample, Clojure
layout: library
repo: clojure
---
6 changes: 6 additions & 0 deletions samples/composer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Composer
keywords: library, sample, Composer
layout: library
repo: composer
---
6 changes: 6 additions & 0 deletions samples/consul.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Consul
keywords: library, sample, Consul
layout: library
repo: consul
---
6 changes: 6 additions & 0 deletions samples/convertigo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Convertigo
keywords: library, sample, Convertigo
layout: library
repo: convertigo
---
8 changes: 8 additions & 0 deletions samples/couchbase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Couchbase
keywords: library, sample, Couchbase
layout: library
repo: couchbase
redirect_from:
- /engine/examples/couchbase/
---
6 changes: 6 additions & 0 deletions samples/couchdb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: CouchDB
keywords: library, sample, CouchDB
layout: library
repo: couchdb
---
6 changes: 6 additions & 0 deletions samples/crate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Crate
keywords: library, sample, Crate
layout: library
repo: crate
---
6 changes: 6 additions & 0 deletions samples/crux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: CRUX
keywords: library, sample, CRUX
layout: library
repo: crux
---
6 changes: 6 additions & 0 deletions samples/debian.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Debian
keywords: library, sample, Debian
layout: library
repo: debian
---
6 changes: 6 additions & 0 deletions samples/django.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Django
keywords: library, sample, Django
layout: library
repo: django
---
6 changes: 6 additions & 0 deletions samples/docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Docker in Docker
keywords: library, sample, Docker in Docker
layout: library
repo: docker
---
6 changes: 6 additions & 0 deletions samples/drupal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Drupal
keywords: library, sample, Drupal
layout: library
repo: drupal
---
6 changes: 6 additions & 0 deletions samples/eclipse-mosquitto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Eclipse Mosquitto
keywords: library, sample, Eclipse Mosquitto
layout: library
repo: eclipse-mosquitto
---
Loading

0 comments on commit 94826e9

Please sign in to comment.