Skip to content

Commit 1794d77

Browse files
committed
Release 2020.3.1: document updates
1 parent 54c483a commit 1794d77

File tree

2 files changed

+28
-19
lines changed

2 files changed

+28
-19
lines changed

docs/firefly-docker.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,31 @@
1-
Firefly from docker
1+
Firefly from Docker
22
-----------------------
33

44
#### Docker:
55

66
- Firefly is containerized and can be pulled from docker
77
- Docker images allow users to run software from a container that has the required software stack.
8-
- Documentation about docker can be found here: https://www.docker.com
8+
- Documentation about Docker can be found here: https://www.docker.com
99

1010

1111
#### How to run Firefly from a docker image?
1212

13-
To run latest/nightly dev:
13+
To run latest or nightly dev:
1414

15-
`docker run -p 8090:8080 --memory=8g --rm ipac/firefly:nightly`
15+
- `docker run -p 8090:8080 -m 4g --rm ipac/firefly:latest`
16+
- `docker run -p 8090:8080 -m 4g --rm ipac/firefly:nightly`
1617

17-
See tags here: https://hub.docker.com/r/ipac/firefly/tags
1818

1919
Then, for example,
20-
- access Firefly tests from the browser with http://localhost:8090/firefly/test/
21-
- Import and use Firefly API into your HTML using:
20+
- Access Firefly with: http://localhost:8090/firefly/
21+
- JavaScript API
22+
- Import and use the JavaScript Firefly API embedded into your HTML using:
23+
- `<script type="text/javascript" src="http://localhost:8090/firefly/firefly_loader.js"></script>`
24+
- Examples of using the JS API are on the test page: http://localhost:8090/firefly/test/
25+
- [Documentation Here](./firefly-api-overview.md)
2226

23-
`<script type="text/javascript" src="http://localhost:8090/firefly/firefly_loader.js"></script>`
2427

25-
More advanced command line here: [firefly/docker/base/start-examples.txt](../docker/base/start-examples.txt)
2628

29+
More advanced Docker start commands: Go to do Firefly Docker page: https://hub.docker.com/r/ipac/firefly
30+
31+
See all tags here: https://hub.docker.com/r/ipac/firefly/tags

docs/release-notes.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
1-
# Release Notes
1+
# Firefly Release Notes
22

3-
You can find Firefly builds and the notes for running Firefly are on the [Docker Page](https://hub.docker.com/r/ipac/firefly).
3+
- You can find Firefly builds and the notes for running Firefly are on the [Docker Page](https://hub.docker.com/r/ipac/firefly).
4+
- See Firefly docker guidelines [here](firefly-docker.md).
5+
- To Access current (unstable) development - (Version _next_, unreleased) use docker tag: `nightly`
46

5-
See Firefly docker guidelines [here](firefly-docker.md).
6-
7-
##### To Access current development - (Version _next_, unreleased)
8-
9-
- docker tag: `nightly`
10-
11-
# Firefly Releases
7+
# Releases
128

139
### Version 2020.3
1410
- October 2020
@@ -39,7 +35,15 @@ See Firefly docker guidelines [here](firefly-docker.md).
3935

4036
##### _Patches 2020.3_
4137
- 2020.3.1
42-
- Many small bug fixes and regression issues
38+
- Docker startup simplified when mapping directories ([Simplfy Docker file](https://github.com/Caltech-IPAC/firefly/pull/1038))
39+
- Many small bug fixes and regression issues:
40+
[IRSA-3757](https://github.com/Caltech-IPAC/firefly/pull/1040),
41+
[IRSA-3729](https://github.com/Caltech-IPAC/firefly/pull/1039),
42+
[IRSA-3771](https://github.com/Caltech-IPAC/firefly/pull/1037),
43+
[Firefly-676](https://github.com/Caltech-IPAC/firefly/pull/1036),
44+
[Firefly-674](https://github.com/Caltech-IPAC/firefly/pull/1035),
45+
[Firefly-670](https://github.com/Caltech-IPAC/firefly/pull/1034),
46+
[Firefly-525](https://github.com/Caltech-IPAC/firefly/pull/1033)
4347

4448
##### _Pull Request in this release_
4549
- [bug fixes](https://github.com/Caltech-IPAC/firefly/pulls?q=is%3Apr+milestone%3A2020.3+label%3Abug)

0 commit comments

Comments
 (0)