Commit 132f3545 authored by Phil Hughes's avatar Phil Hughes

Added docs for Web IDE Client Evaluation

Closes #50143
parent 00c474ae
......@@ -72,5 +72,37 @@ leaving the Web IDE. Click the dropdown in the top of the sidebar to open a list
of branches. You will need to commit or discard all your changes before
switching to a different branch.
## Clientside Evaluation
> [Introduced in](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/19764) [GitLab Core][ce] 11.2.
The Web IDE can be used to preview JavaScript projects right in the browser. This
feature uses CodeSandbox to compile and bundle the JavaScript used to preview.
On public projects, a `Open in CodeSandbox` button visible which will take
the files and contents of the project and load it into a CodeSandbox project.
**Note** this button is not visible on private or internal projects.
![Web IDE Clientside Evaluation](img/clientside_evaluation.png)
### Enabling Clientside Evaluation
The Clientside Evaluation feature needs to be enabled inside of the GitLab instances
admin settings.
![Admin Clientside Evaluation setting](img/admin_clientside_evaluation.png)
Once it has been enabled in application settings, projects with a `package.json` file
and a `main` entry point can be previewed inside of the Web IDE. An example `package.json`
is below.
```json
{
"main": "index.js",
"dependencies": {
"vue": "latest"
}
}
```
[ce]: https://about.gitlab.com/pricing/
[ee]: https://about.gitlab.com/pricing/
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment