Skip to content

Commit d8b63b5

Browse files
Update docs for the release 0.7.0 (#714)
* Update docs for the release * update image * update changelog * missing new fix
1 parent 4406754 commit d8b63b5

File tree

5 files changed

+130
-69
lines changed

5 files changed

+130
-69
lines changed

CHANGELOG.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,56 @@
1+
# 0.7.0
2+
[All items](https://github.com/Azure/BatchLabs/milestone/8?closed=1)
3+
4+
### Features:
5+
* Ability to view third party notice from UI [\#690](https://github.com/Azure/BatchLabs/issues/690)
6+
* Command line input for task improvement [\#670](https://github.com/Azure/BatchLabs/issues/670)
7+
* Add files to a file group with drag and drop [\#651](https://github.com/Azure/BatchLabs/issues/651)
8+
* Add refresh shortcut to work in prod build [\#647](https://github.com/Azure/BatchLabs/issues/647)
9+
* User identity for task [\#639](https://github.com/Azure/BatchLabs/issues/639)
10+
* Clean up excessive console errors when task logs are not available on node [\#631](https://github.com/Azure/BatchLabs/issues/631)
11+
* Add 3ds max to the application license picker [\#627](https://github.com/Azure/BatchLabs/issues/627)
12+
* Job tasks running time graph sorting/grouping of x axis [\#624](https://github.com/Azure/BatchLabs/issues/624)
13+
* Add charts on the job home page(when no jobs selected) [\#621](https://github.com/Azure/BatchLabs/issues/621)
14+
* Feature: File explorer [\#614](https://github.com/Azure/BatchLabs/issues/614)
15+
* Make an install command to help people getting started(windows) [\#610](https://github.com/Azure/BatchLabs/issues/610)
16+
* Add more charts for a job [\#473](https://github.com/Azure/BatchLabs/issues/473)
17+
* Settings page [\#472](https://github.com/Azure/BatchLabs/issues/472)
18+
* Tree view for files [\#466](https://github.com/Azure/BatchLabs/issues/466)
19+
* Provide built app for download [\#405](https://github.com/Azure/BatchLabs/issues/405)
20+
* Smart card support for windows [\#271](https://github.com/Azure/BatchLabs/issues/271)
21+
22+
### Bugs:
23+
* Heatmap display bug when resizing window or pool resize [\#715](https://github.com/Azure/BatchLabs/issues/715)
24+
* Exit code is not showing in the task table list [\#712](https://github.com/Azure/BatchLabs/issues/712)
25+
* Job preparation and release task having styling issues [\#709](https://github.com/Azure/BatchLabs/issues/709)
26+
* Progress getting lost if file group name is too large [\#704](https://github.com/Azure/BatchLabs/issues/704)
27+
* File explorer not reading files from storage account. [\#702](https://github.com/Azure/BatchLabs/issues/702)
28+
* Job graph is overflowing vertically when in running prod [\#697](https://github.com/Azure/BatchLabs/issues/697)
29+
* File explorer long file/folder name wrapping bug [\#668](https://github.com/Azure/BatchLabs/issues/668)
30+
* Autoscale formula not updating [\#665](https://github.com/Azure/BatchLabs/issues/665)
31+
* Profile settings throws an error for user settings [\#661](https://github.com/Azure/BatchLabs/issues/661)
32+
* Profile menu item forces navigation to dashboard and reload when closed. [\#660](https://github.com/Azure/BatchLabs/issues/660)
33+
* File explorer improve errors on task outputs [\#654](https://github.com/Azure/BatchLabs/issues/654)
34+
* UI gets into a bad state if you navigate to a start task which has an environment variable with no value [\#646](https://github.com/Azure/BatchLabs/issues/646)
35+
* Task id needs to be truncated in the table [\#645](https://github.com/Azure/BatchLabs/issues/645)
36+
* run elevated not set when running tasks with autoUser in admin mode [\#638](https://github.com/Azure/BatchLabs/issues/638)
37+
* Batchlabs ghost process after closing prod app [\#633](https://github.com/Azure/BatchLabs/issues/633)
38+
* Detailed information should be shown if an error occurs during allocation [\#618](https://github.com/Azure/BatchLabs/issues/618)
39+
* Splash screen not showing in packaged distributable [\#616](https://github.com/Azure/BatchLabs/issues/616)
40+
* Graph hover text [\#608](https://github.com/Azure/BatchLabs/issues/608)
41+
* Grammar in task running time graph [\#607](https://github.com/Azure/BatchLabs/issues/607)
42+
* Handle forbidden 403 errors [\#577](https://github.com/Azure/BatchLabs/issues/577)
43+
* Cannot read a blob from a file group with a full path. [\#561](https://github.com/Azure/BatchLabs/issues/561)
44+
45+
### Other:
46+
* Update readme to prepare for the release [\#692](https://github.com/Azure/BatchLabs/issues/692)
47+
* ThirdPartyNotice generator [\#682](https://github.com/Azure/BatchLabs/issues/682)
48+
* Log python stdout and stderr to file [\#678](https://github.com/Azure/BatchLabs/issues/678)
49+
* Find an open port for the python server to connect to [\#676](https://github.com/Azure/BatchLabs/issues/676)
50+
* Switch to es6 [\#641](https://github.com/Azure/BatchLabs/issues/641)
51+
* Table selection/activation improvement [\#626](https://github.com/Azure/BatchLabs/issues/626)
52+
* Upload file group as a background task [\#615](https://github.com/Azure/BatchLabs/issues/615)
53+
154
# Version 0.6.0(Beta)
255
[All items](https://github.com/Azure/BatchLabs/milestone/6?closed=1)
356

Readme.md

Lines changed: 8 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
# BatchLabs
22
[![Build Status](https://travis-ci.org/Azure/BatchLabs.svg?branch=master)](https://travis-ci.org/Azure/BatchLabs)
33

4-
**Note: BatchLabs is in beta. We don't provide any installer/packaged binaries as of now. You will need to build this app yourself.**
4+
**Note: BatchLabs is in preview.**
55

6-
This is the readme for the 'master' branch which contains the latest changes, 'stable' may differ from this [Stable readme](https://github.com/Azure/BatchLabs/tree/stable)
76

87
## Description
98

109
Batch Labs is a tool to manage your Azure Batch accounts. The goal is to implement a great user experience that will help you debug, monitor and manage your pools, jobs and tasks.
1110
It will also include expermiental features such as `Batch Templates` in the aim to improve your Batch experience. We are open to any feedback, ideas and contributions you might have.
1211

13-
## Getting started
12+
![](docs/images/job-home.png)
13+
14+
## Downloads
15+
16+
You can download the latest version at https://github.com/Azure/BatchLabs/releases
17+
18+
## Building batchlabs yourself
1419
#### 1. Prerequisites
1520
- **Install node.js version `6.9` or greater. [Download](https://nodejs.org/en/download/)**
1621
- Install python **3.6** (doesn't need to be in the path if that breaks your environment)
@@ -58,72 +63,6 @@ npm run electron
5863
## Developers
5964
[Dev docs](docs/readme.md)
6065

61-
For developers, you can set up a development environment as follows:
62-
**Use `yarn install` instead of `npm install`. This ensures a consistent build environment with the right set of dependencies [Migrating from npm to yarn](https://yarnpkg.com/lang/en/docs/migrating-from-npm/)**
63-
64-
Start the dev server
65-
```bash
66-
npm run dev-server
67-
```
68-
69-
Start electron
70-
```bash
71-
# In the command line
72-
npm run dev-electron
73-
74-
# In VSCode just press F5
75-
```
76-
77-
The dev-server and dev-electron support hot reload for a better development experience. Simply saving a file will cause the UI to refresh to your updated changes.
78-
79-
*Note:* Changes to any files in the node client directory ('src/client') require restarting the application.
80-
81-
If you're using VSCode (recommended) we suggest you use the following extensions:
82-
* Debugger for Chrome
83-
* EditorConfig for VS Code
84-
* TSLint
85-
86-
Please also take a look at the [coding guidelines](coding-guidelines.md) for this repo for best practices.
87-
88-
## Testing
89-
90-
[Testing doc](docs/testing.md)
91-
92-
## Editor
93-
94-
In vscode install the editorconfig extension
95-
96-
## Detailed commands:
97-
**Magic command (starts the server and electron in dev mode)**
98-
```
99-
npm run dev
100-
```
101-
102-
Build project
103-
```
104-
npm run build
105-
```
106-
107-
Run app
108-
```
109-
npm run electron
110-
```
111-
112-
Run watch (this will build files on save)
113-
```
114-
npm run watch
115-
```
116-
117-
Run dev server (this will handle the refresh of files and later should have live reload)
118-
```
119-
npm run dev-server
120-
```
121-
122-
Run dev electron (to use the dev server you need to run this)
123-
```
124-
npm run dev-electron
125-
```
126-
12766
## License
12867

12968
Batch labs is licensed under MIT [See license](LICENSE)

docs/images/job-home.png

139 KB
Loading

docs/readme.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Dev docs
22

3+
## Getting started
4+
* [Setup your dev environment](setup.md)
5+
36
## Main
47
* [Components](components.md)
58
* [Models](models.md)

docs/setup.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Setup your environment
2+
3+
4+
## 1. Prerequisites
5+
Follow the **Building batchlabs yourself** instruction of the [main readme](../Readme.md) in order to install all require dependencies.
6+
7+
**Use `yarn install` instead of `npm install`. This ensures a consistent build environment with the right set of dependencies [Migrating from npm to yarn](https://yarnpkg.com/lang/en/docs/migrating-from-npm/)**
8+
9+
Start the dev server
10+
```bash
11+
npm run dev-server
12+
```
13+
14+
Start electron
15+
```bash
16+
# In the command line
17+
npm run dev-electron
18+
19+
# In VSCode just press F5
20+
```
21+
22+
The dev-server and dev-electron support hot reload for a better development experience. Simply saving a file will cause the UI to refresh to your updated changes.
23+
24+
*Note:* Changes to any files in the node client directory ('src/client') require restarting the application.
25+
26+
27+
28+
Please also take a look at the [coding guidelines](coding-guidelines.md) for this repo for best practices.
29+
30+
## Editor
31+
32+
If you're using VSCode (recommended) we suggest you use the following extensions:
33+
* EditorConfig for VS Code(Important)
34+
* TSLint
35+
* Debugger for Chrome
36+
37+
## Detailed commands:
38+
**Magic command (starts the server and electron in dev mode)**
39+
```
40+
npm run dev
41+
```
42+
43+
Build project
44+
```
45+
npm run build
46+
```
47+
48+
Run app
49+
```
50+
npm run electron
51+
```
52+
53+
Run watch (this will build files on save)
54+
```
55+
npm run watch
56+
```
57+
58+
Run dev server (this will handle the refresh of files and later should have live reload)
59+
```
60+
npm run dev-server
61+
```
62+
63+
Run dev electron (to use the dev server you need to run this)
64+
```
65+
npm run dev-electron
66+
```

0 commit comments

Comments
 (0)