mirror of https://github.com/docker/docs.git
Include extensions-sdk docs from upstream repo (#14658)
* First inclusion of extensions-sdk docs from upstream repo Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com> * Mark extension as Beta, not Preview Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
This commit is contained in:
parent
5534cd211e
commit
82f77a9064
23
Dockerfile
23
Dockerfile
|
@ -22,6 +22,9 @@ ARG DISTRIBUTION_BRANCH="release/2.7"
|
||||||
# Compose CLI
|
# Compose CLI
|
||||||
ARG COMPOSE_CLI_BRANCH="main"
|
ARG COMPOSE_CLI_BRANCH="main"
|
||||||
|
|
||||||
|
# extensions SDK
|
||||||
|
ARG EXTENSIONS_SDK_BRANCH="main"
|
||||||
|
|
||||||
###
|
###
|
||||||
# Set up base stages for building and deploying
|
# Set up base stages for building and deploying
|
||||||
###
|
###
|
||||||
|
@ -40,6 +43,9 @@ ENV DISTRIBUTION_BRANCH=${DISTRIBUTION_BRANCH}
|
||||||
ARG COMPOSE_CLI_BRANCH
|
ARG COMPOSE_CLI_BRANCH
|
||||||
ENV COMPOSE_CLI_BRANCH=${COMPOSE_CLI_BRANCH}
|
ENV COMPOSE_CLI_BRANCH=${COMPOSE_CLI_BRANCH}
|
||||||
|
|
||||||
|
ARG EXTENSIONS_SDK_BRANCH
|
||||||
|
ENV EXTENSIONS_SDK_BRANCH=${EXTENSIONS_SDK_BRANCH}
|
||||||
|
|
||||||
# Fetch upstream resources (reference documentation)
|
# Fetch upstream resources (reference documentation)
|
||||||
# Only add the files that are needed to build these reference docs, so that these
|
# Only add the files that are needed to build these reference docs, so that these
|
||||||
# docs are only rebuilt if changes were made to ENGINE_BRANCH or DISTRIBUTION_BRANCH.
|
# docs are only rebuilt if changes were made to ENGINE_BRANCH or DISTRIBUTION_BRANCH.
|
||||||
|
@ -51,6 +57,7 @@ COPY ./_scripts/fetch-upstream-resources.sh ./_scripts/
|
||||||
ARG ENGINE_BRANCH
|
ARG ENGINE_BRANCH
|
||||||
ARG DISTRIBUTION_BRANCH
|
ARG DISTRIBUTION_BRANCH
|
||||||
ARG COMPOSE_CLI_BRANCH
|
ARG COMPOSE_CLI_BRANCH
|
||||||
|
ARG EXTENSIONS_SDK_BRANCH
|
||||||
RUN ./_scripts/fetch-upstream-resources.sh .
|
RUN ./_scripts/fetch-upstream-resources.sh .
|
||||||
|
|
||||||
|
|
||||||
|
@ -65,14 +72,14 @@ RUN ./_scripts/update-api-toc.sh
|
||||||
ARG JEKYLL_ENV
|
ARG JEKYLL_ENV
|
||||||
RUN echo "Building docs for ${JEKYLL_ENV} environment"
|
RUN echo "Building docs for ${JEKYLL_ENV} environment"
|
||||||
RUN set -eu; \
|
RUN set -eu; \
|
||||||
if [ "${JEKYLL_ENV}" = "production" ]; then \
|
if [ "${JEKYLL_ENV}" = "production" ]; then \
|
||||||
jekyll build --profile -d ${TARGET} --config _config.yml,_config_production.yml; \
|
jekyll build --profile -d ${TARGET} --config _config.yml,_config_production.yml; \
|
||||||
sed -i 's#<loc>/#<loc>https://docs.docker.com/#' "${TARGET}/sitemap.xml"; \
|
sed -i 's#<loc>/#<loc>https://docs.docker.com/#' "${TARGET}/sitemap.xml"; \
|
||||||
else \
|
else \
|
||||||
jekyll build --profile -d ${TARGET}; \
|
jekyll build --profile -d ${TARGET}; \
|
||||||
echo '[]' > ${TARGET}/js/metadata.json; \
|
echo '[]' > ${TARGET}/js/metadata.json; \
|
||||||
fi; \
|
fi; \
|
||||||
find ${TARGET} -type f -name '*.html' | while read i; do sed -i 's#\(<a[^>]* href="\)https://docs.docker.com/#\1/#g' "$i"; done;
|
find ${TARGET} -type f -name '*.html' | while read i; do sed -i 's#\(<a[^>]* href="\)https://docs.docker.com/#\1/#g' "$i"; done;
|
||||||
|
|
||||||
|
|
||||||
# This stage only contains the generated files. It can be used to host the
|
# This stage only contains the generated files. It can be used to host the
|
||||||
|
|
104
_data/toc.yaml
104
_data/toc.yaml
|
@ -1034,6 +1034,56 @@ reference:
|
||||||
path: /docker-hub/api/latest/
|
path: /docker-hub/api/latest/
|
||||||
- title: Registry API
|
- title: Registry API
|
||||||
path: /registry/spec/api/
|
path: /registry/spec/api/
|
||||||
|
- sectiontitle: Docker Extension SDK API (Beta)
|
||||||
|
section:
|
||||||
|
- path:
|
||||||
|
title:
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/DesktopUI/
|
||||||
|
title: DesktopUI
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/Dialog/
|
||||||
|
title: Dialog
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/Docker/
|
||||||
|
title: Docker
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/DockerCommand/
|
||||||
|
title: DockerCommand
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient/
|
||||||
|
title: DockerDesktopClient
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/Exec/
|
||||||
|
title: Exec
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/ExecProcess/
|
||||||
|
title: ExecProcess
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/ExecResult/
|
||||||
|
title: ExecResult
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions/
|
||||||
|
title: ExecStreamOptions
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/Extension/
|
||||||
|
title: Extension
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionCli/
|
||||||
|
title: ExtensionCli
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionHost/
|
||||||
|
title: ExtensionHost
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionVM/
|
||||||
|
title: ExtensionVM
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/Host/
|
||||||
|
title: Host
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/HttpService/
|
||||||
|
title: HttpService
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/NavigationIntents/
|
||||||
|
title: NavigationIntents
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult/
|
||||||
|
title: OpenDialogResult
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/RawExecResult/
|
||||||
|
title: RawExecResult
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/RequestConfig/
|
||||||
|
title: RequestConfig
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0/
|
||||||
|
title: RequestConfigV0
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/Toast/
|
||||||
|
title: Toast
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/ExecResultV0/
|
||||||
|
title: ExecResultV0
|
||||||
|
- path: /desktop/extensions-sdk/dev/api/reference/interfaces/BackendV0/
|
||||||
|
title: BackendV0
|
||||||
- title: Dockerfile reference
|
- title: Dockerfile reference
|
||||||
path: /engine/reference/builder/
|
path: /engine/reference/builder/
|
||||||
- sectiontitle: Compose file reference
|
- sectiontitle: Compose file reference
|
||||||
|
@ -1189,7 +1239,59 @@ manuals:
|
||||||
- path: /desktop/dev-environments/
|
- path: /desktop/dev-environments/
|
||||||
title: Dev Environments (Preview)
|
title: Dev Environments (Preview)
|
||||||
- path: /desktop/extensions/
|
- path: /desktop/extensions/
|
||||||
title: Extensions (Preview)
|
title: Extensions (Beta)
|
||||||
|
- sectiontitle: Extensions SDK (Beta)
|
||||||
|
section:
|
||||||
|
- path: /desktop/extensions-sdk/
|
||||||
|
title: Introduction
|
||||||
|
- sectiontitle: Tutorials
|
||||||
|
section:
|
||||||
|
- title: Create your first extension
|
||||||
|
path: /desktop/extensions-sdk/tutorials/initialize/
|
||||||
|
- title: Create a minimal frontend extension
|
||||||
|
path: /desktop/extensions-sdk/tutorials/minimal-frontend-extension/
|
||||||
|
- title: Create a ReactJS-based extension
|
||||||
|
path: /desktop/extensions-sdk/tutorials/react-extension/
|
||||||
|
- title: Create a minimal extension invoking docker commands
|
||||||
|
path: /desktop/extensions-sdk/tutorials/minimal-frontend-using-docker-cli/
|
||||||
|
- title: Create a minimal backend extension
|
||||||
|
path: /desktop/extensions-sdk/tutorials/minimal-backend-extension/
|
||||||
|
- title: Design Guidelines
|
||||||
|
path: /desktop/extensions-sdk/design/design-overview/
|
||||||
|
- sectiontitle: Extensions
|
||||||
|
section:
|
||||||
|
- title: Metadata
|
||||||
|
path: /desktop/extensions-sdk/extensions/METADATA/
|
||||||
|
- title: Labels
|
||||||
|
path: /desktop/extensions-sdk/extensions/labels/
|
||||||
|
- title: Validation
|
||||||
|
path: /desktop/extensions-sdk/extensions/validation/
|
||||||
|
- title: Distribution
|
||||||
|
path: /desktop/extensions-sdk/extensions/DISTRIBUTION/
|
||||||
|
- title: Building multi-arch extensions
|
||||||
|
path: /desktop/extensions-sdk/extensions/multi-arch/
|
||||||
|
- sectiontitle: Developer guide
|
||||||
|
section:
|
||||||
|
- title: Overview
|
||||||
|
path: /desktop/extensions-sdk/dev/overview/
|
||||||
|
- title: CLI overview
|
||||||
|
path: /desktop/extensions-sdk/dev/cli/usage/
|
||||||
|
- title: Build, test and install an extension
|
||||||
|
path: /desktop/extensions-sdk/dev/cli/build-test-install-extension/
|
||||||
|
- sectiontitle: UI API
|
||||||
|
section:
|
||||||
|
- title: Overview
|
||||||
|
path: /desktop/extensions-sdk/dev/api/overview/
|
||||||
|
- title: Extension Backend
|
||||||
|
path: /desktop/extensions-sdk/dev/api/backend/
|
||||||
|
- title: Docker
|
||||||
|
path: /desktop/extensions-sdk/dev/api/docker/
|
||||||
|
- title: Dashboard
|
||||||
|
path: /desktop/extensions-sdk/dev/api/dashboard/
|
||||||
|
- title: Navigation
|
||||||
|
path: /desktop/extensions-sdk/dev/api/dashboard-routes-navigation/
|
||||||
|
- title: API Reference
|
||||||
|
path: /desktop/extensions-sdk/dev/api/reference/README/
|
||||||
- path: /desktop/multi-arch/
|
- path: /desktop/multi-arch/
|
||||||
title: Multi-arch support
|
title: Multi-arch support
|
||||||
- path: /desktop/kubernetes/
|
- path: /desktop/kubernetes/
|
||||||
|
|
|
@ -7,6 +7,7 @@
|
||||||
: "${ENGINE_BRANCH?No release branch set for docker/docker and docker/cli}"
|
: "${ENGINE_BRANCH?No release branch set for docker/docker and docker/cli}"
|
||||||
: "${DISTRIBUTION_BRANCH?No release branch set for distribution/distribution}"
|
: "${DISTRIBUTION_BRANCH?No release branch set for distribution/distribution}"
|
||||||
: "${COMPOSE_CLI_BRANCH?No release branch set for docker/compose-cli}"
|
: "${COMPOSE_CLI_BRANCH?No release branch set for docker/compose-cli}"
|
||||||
|
: "${EXTENSIONS_SDK_BRANCH?No release branch set for docker/extensions-sdk}"
|
||||||
|
|
||||||
# Translate branches for use by svn
|
# Translate branches for use by svn
|
||||||
engine_svn_branch="branches/${ENGINE_BRANCH}"
|
engine_svn_branch="branches/${ENGINE_BRANCH}"
|
||||||
|
@ -21,11 +22,16 @@ compose_cli_svn_branch="branches/${COMPOSE_CLI_BRANCH}"
|
||||||
if [ "${compose_cli_svn_branch}" = "branches/main" ]; then
|
if [ "${compose_cli_svn_branch}" = "branches/main" ]; then
|
||||||
compose_cli_svn_branch=trunk
|
compose_cli_svn_branch=trunk
|
||||||
fi
|
fi
|
||||||
|
extensions_sdk_svn_branch="branches/${EXTENSIONS_SDK_BRANCH}"
|
||||||
|
if [ "${extensions_sdk_svn_branch}" = "branches/main" ]; then
|
||||||
|
extensions_sdk_svn_branch=trunk
|
||||||
|
fi
|
||||||
|
|
||||||
# Directories to get via SVN. We use this because you can't use git to clone just a portion of a repository
|
# Directories to get via SVN. We use this because you can't use git to clone just a portion of a repository
|
||||||
svn co "https://github.com/docker/cli/${engine_svn_branch}/docs/extend" ./engine/extend || (echo "Failed engine/extend download" && exit 1)
|
svn co "https://github.com/docker/cli/${engine_svn_branch}/docs/extend" ./engine/extend || (echo "Failed engine/extend download" && exit 1)
|
||||||
svn co "https://github.com/docker/docker/${engine_svn_branch}/docs/api" ./engine/api || (echo "Failed engine/api download" && exit 1)
|
svn co "https://github.com/docker/docker/${engine_svn_branch}/docs/api" ./engine/api || (echo "Failed engine/api download" && exit 1)
|
||||||
svn co "https://github.com/docker/compose-cli/${compose_cli_svn_branch}/docs" ./cloud || (echo "Failed compose-cli/docs download" && exit 1)
|
svn co "https://github.com/docker/compose-cli/${compose_cli_svn_branch}/docs" ./cloud || (echo "Failed compose-cli/docs download" && exit 1)
|
||||||
|
svn co "https://github.com/docker/extensions-sdk/${extensions_sdk_svn_branch}/docs" ./desktop/extensions-sdk || (echo "Failed extensions-sdk/docs download" && exit 1)
|
||||||
svn co "https://github.com/distribution/distribution/${distribution_svn_branch}/docs/spec" ./registry/spec || (echo "Failed registry/spec download" && exit 1)
|
svn co "https://github.com/distribution/distribution/${distribution_svn_branch}/docs/spec" ./registry/spec || (echo "Failed registry/spec download" && exit 1)
|
||||||
|
|
||||||
# Fix up URls in swagger files
|
# Fix up URls in swagger files
|
||||||
|
|
Loading…
Reference in New Issue