From a25a0b567db0c40d189d0a2a2f65719baaa613c5 Mon Sep 17 00:00:00 2001 From: Guillaume Tardif Date: Tue, 3 May 2022 12:30:36 +0200 Subject: [PATCH] Remove references to netlify site, as this is going to be published to docs.docker.com Signed-off-by: Guillaume Tardif --- .github/workflows/netlify.yaml | 38 ---------------------------------- README.md | 18 +--------------- 2 files changed, 1 insertion(+), 55 deletions(-) delete mode 100644 .github/workflows/netlify.yaml diff --git a/.github/workflows/netlify.yaml b/.github/workflows/netlify.yaml deleted file mode 100644 index e0f0c103..00000000 --- a/.github/workflows/netlify.yaml +++ /dev/null @@ -1,38 +0,0 @@ -name: Build and Deploy to Netlify -on: - release: - types: [published] # a release, pre-release, or draft of a release is published - - workflow_dispatch: - inputs: - branch: - description: "Branch" - required: true - default: "main" - tag: - description: "Release Tag" -jobs: - build: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - - name: Build the Docs - uses: addnab/docker-run-action@v3 - with: - image: squidfunk/mkdocs-material:latest - options: -v ${{ github.workspace }}:/docs - run: mkdocs build - - - name: Deploy to Netlify - uses: nwtgck/actions-netlify@v1.2 - with: - publish-dir: "./site" - production-deploy: true - production-branch: main - github-token: ${{ secrets.GITHUB_TOKEN }} - deploy-message: "Deploy from GitHub Actions. Commit: ${{ github.sha }}" - env: - NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_DOCKER_EXTENSIONS_AUTH_TOKEN }} - NETLIFY_SITE_ID: ${{ secrets.NETLIFY_DOCKER_EXTENSIONS_SITE_ID }} - timeout-minutes: 3 diff --git a/README.md b/README.md index 7db42a73..0faa0274 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,9 @@ # Docker Extensions -[![Netlify Status](https://api.netlify.com/api/v1/badges/883a0d5e-15c4-471b-a3e3-84cf27d2fced/deploy-status)](https://app.netlify.com/sites/docker-desktop-extensions/deploys) - This repository includes all resources to create Docker Extensions. :warning: **This work is experimental and still in progress, features and APIs are subject to change** -## Documentation - -The documentation is published and best viewed at https://docker-desktop-extensions.netlify.app/. - ## Prerequisites To get started with Docker Extensions you will need a specific Docker Desktop build that comes with extension capabilities and the Extensions CLI. @@ -46,16 +40,6 @@ Furthermore, you can communicate with your extension backend service or invoke a ### UI Guidelines -We are currently in the process of developing our design system but in the meantime, here are some [UI guidelines](https://www.figma.com/file/U7pLWfEf6IQKUHLhdateBI/Docker-Design-Guidelines?node-id=1%3A28771). Docker Desktop's UI is written in React and [Material-UI](https://mui.com/), and we strongly recommend adopting this combination in your extensions as well. This brings the benefit of using our [Material-UI Theme](https://www.npmjs.com/package/@docker/docker-mui-theme) to easily replicate Docker Desktop's look & feel, and we'll continue to release libraries and utilities targeting this combination. +We are currently in the process of developing our design system but in the meantime, here are some [UI guidelines](https://www.figma.com/file/U7pLWfEf6IQKUHLhdateBI/Docker-Design-Guidelines?node-id=1%3A28771). Docker Desktop's UI is written in React and [Material-UI](https://mui.com/), and we strongly recommend adopting this combination in your extensions as well. This brings the benefit of using our [Material-UI Theme](https://www.npmjs.com/package/@docker/docker-mui-theme) to easily replicate Docker Desktop's look & feel, and we'll continue to release libraries and utilities targeting this combination. You can read more about our design principles [here](/docs/design/design-overview.md). - -## Build the documentation - -We use [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) to create a static site from a set of Markdown files under [docs](./docs). - -```bash -docker run --rm -it -p 8000:8000 --rm -v ${PWD}:/docs squidfunk/mkdocs-material -``` - -Visit http://0.0.0.0:8000/