Skip to content

Commit

Permalink
Remove references to netlify site, as this is going to be published t…
Browse files Browse the repository at this point in the history
…o docs.docker.com

Signed-off-by: Guillaume Tardif <[email protected]>
  • Loading branch information
gtardif committed May 3, 2022
1 parent d541fd7 commit a25a0b5
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 55 deletions.
38 changes: 0 additions & 38 deletions .github/workflows/netlify.yaml

This file was deleted.

18 changes: 1 addition & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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/

0 comments on commit a25a0b5

Please sign in to comment.