Skip to content

Commit 25707bb

Browse files
committed
Improve documentation
1 parent 8721979 commit 25707bb

File tree

5 files changed

+50
-15
lines changed

5 files changed

+50
-15
lines changed

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
This documentation contains everything you need to know for using Codebox or running it locally. You can contribute to this documentation with pull-requests on Github: [Codebox Repository](https://github.com/FriendCode/codebox).
1+
This documentation contains everything you need to know for using Codebox or running it locally. You can contribute to this documentation [with pull-requests on Github](https://github.com/FriendCode/codebox).
22

33
---------------------------------------
44

docs/server/env.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,11 @@ Codebox use environment variables for defining its conffiguration, here is a lis
77
| WORKSPACE_DIR | Workspace current directory | Shell current directory |
88
| WORKSPACE_NAME | Name for this workspace | "Workspace" |
99
| WORKSPACE_PUBLIC | If defined the workspace will be considered as public | false |
10-
| WORKSPACE_USERS_MAX | Max number of users | 100 |
11-
| WORKSPACE_HOOK_AUTH | Url for the authentification hook | |
12-
| WORKSPACE_HOOK_EVENTS | Url for the events hook | |
13-
| WORKSPACE_HOOK_SETTINGS | Url for the settings hook | |
14-
| WORKSPACE_HOOK_TOKEN | Token to pass as Authorization header for all web hooks | |
15-
| WORKSPACE_ADDONS_DIR | Path to the directory where to store installed addons | addons/installed |
16-
| WORKSPACE_ADDONS_DEFAULTS_DIR | Path to the directory where to store (or where are stored) defaults addons | addons/defaults |
17-
| WORKSPACE_ADDONS_TEMP_DIR | Path to the directory where to temporary store installed addons | system temporary directory |
18-
| WORKSPACE_ADDONS_DEFAULTS | List of git url for defaults addons (separated by commas) | Terminal, Editor, Manager, Settings, Video Chat |
10+
| WORKSPACE\_USERS\_MAX | Max number of users | 100 |
11+
| WORKSPACE\_HOOK\_AUTH | Url for the authentification hook | |
12+
| WORKSPACE\_HOOK\_EVENTS | Url for the events hook | |
13+
| WORKSPACE\_HOOK\_SETTINGS | Url for the settings hook | |
14+
| WORKSPACE\_HOOK\_TOKEN | Token to pass as Authorization header for all web hooks | |
15+
| WORKSPACE\_ADDONS\_DIR | Path to the directory where to store installed addons | addons/installed |
16+
| WORKSPACE\_ADDONS\_DEFAULTS_DIR | Path to the directory where to store (or where are stored) defaults addons | addons/defaults |
17+
| WORKSPACE\_ADDONS\_TEMP_DIR | Path to the directory where to temporary store installed addons | system temporary directory |

src/addons/cb.help/addon-built.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,24 @@
11
.addon-help-dialog {
22
.modal-dialog {
33
@media screen and (min-width: 768px) {
4-
width: 760px;
4+
width: auto;
5+
padding: 10px;
56
}
7+
@media screen and (min-width: 968px) {
8+
width: 960px;
9+
}
10+
}
11+
.modal-body {
12+
padding: 0px;
13+
}
14+
.modal-footer {
15+
margin: 0px;
16+
}
17+
18+
.navbar {
19+
margin: 0px;
20+
}
21+
.help-page-body {
22+
margin: 10px 20px;
623
}
724
}

src/addons/cb.help/templates/dialog.html

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,28 @@
11
<div class="modal-dialog">
22
<div class="modal-content">
3-
<div class="modal-header">
4-
<a href="#" class="action-gohome"><h4 class="modal-title">Help</h4></a>
5-
</div>
63
<div class="modal-body">
4+
<nav class="navbar navbar-default navbar-static-top" role="navigation">
5+
<!-- Brand and toggle get grouped for better mobile display -->
6+
<div class="navbar-header">
7+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-8">
8+
<span class="sr-only">Toggle navigation</span>
9+
<span class="icon-bar"></span>
10+
<span class="icon-bar"></span>
11+
<span class="icon-bar"></span>
12+
</button>
13+
<span class="navbar-brand">Codebox Documentation</span>
14+
</div>
15+
16+
<!-- Collect the nav links, forms, and other content for toggling -->
17+
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-8">
18+
<ul class="nav navbar-nav">
19+
<li><a href="#" class="action-gohome" tabindex="-1">Home</a></li>
20+
</ul>
21+
<ul class="nav navbar-nav navbar-right">
22+
<li><a href="https://github.com/FriendCode/codebox/issues" target="_blank">Report an issue</a></li>
23+
</ul>
24+
</div><!-- /.navbar-collapse -->
25+
</nav>
726
<div class="help-page-body"></div>
827
</div>
928
<div class="modal-footer">

0 commit comments

Comments
 (0)