mirror of https://github.com/coder/coder.git
chore: revert open in coder docs for now (#4154)
* chore: revert open in coder docs for now * remove in dogfood
This commit is contained in:
parent
5fd90471fc
commit
9e099b543f
|
@ -1,27 +0,0 @@
|
||||||
# Open in Coder Button
|
|
||||||
|
|
||||||
Add a Markdown button to your project's `README.md` to get your developers up and running with Coder with a few clicks.
|
|
||||||
|
|
||||||
A basic example looks like this:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
[![Open in Coder](https://cdn.coder.com/embed-button.svg)](https://<deployment-url>/templates/<template-name>)
|
|
||||||
```
|
|
||||||
|
|
||||||
which renders like this:
|
|
||||||
|
|
||||||
![Open in Coder](https://cdn.coder.com/embed-button.svg)
|
|
||||||
|
|
||||||
You can customize this to take developers directly to your team's template. Read on to learn more.
|
|
||||||
|
|
||||||
### Customization
|
|
||||||
|
|
||||||
The underlying link for this button consists of the following pieces:
|
|
||||||
- <deployment-url>: where your Coder deployment lives i.e. https://dev.coder.com
|
|
||||||
- <template-name>: name of template i.e. coder
|
|
||||||
|
|
||||||
### template name
|
|
||||||
|
|
||||||
A template to redirect your developers to after they authenticate on your deployment.
|
|
||||||
|
|
||||||
Example: https://dev.coder.com/templates/coder
|
|
|
@ -188,11 +188,6 @@
|
||||||
"title": "Enterprise",
|
"title": "Enterprise",
|
||||||
"description": "Learn how to enable Enterprise features.",
|
"description": "Learn how to enable Enterprise features.",
|
||||||
"path": "./admin/enterprise.md"
|
"path": "./admin/enterprise.md"
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "Open in Coder Button",
|
|
||||||
"description": "Learn how to create an 'Open in Coder' button.",
|
|
||||||
"path": "./admin/open-in-coder.md"
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|
|
@ -1,7 +1,5 @@
|
||||||
# dogfood template
|
# dogfood template
|
||||||
|
|
||||||
[![Open in Coder](https://cdn.coder.com/embed-button.svg)](https://dev.coder.com/templates/coder)
|
|
||||||
|
|
||||||
Ammar is this template's admin.
|
Ammar is this template's admin.
|
||||||
|
|
||||||
## Personalization
|
## Personalization
|
||||||
|
|
Loading…
Reference in New Issue