Skip to content

Commit 8a8a98b

Browse files
Improve restarts, add port forwarding, adjust docs.
1 parent baf445a commit 8a8a98b

File tree

3 files changed

+28
-8
lines changed

3 files changed

+28
-8
lines changed

.devcontainer/devcontainer.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,14 @@
1616
"ghcr.io/guiyomh/features/vim:0": {}
1717
},
1818
"onCreateCommand": "pip install -e .",
19-
"postStartCommand": "MYSQL_VER=5.7 MINIO_VER=RELEASE.2022-08-11T04-37-28Z docker compose -f local-docker-compose.yml up --build -d",
19+
"postStartCommand": "MYSQL_VER=8.0 MINIO_VER=RELEASE.2022-08-11T04-37-28Z docker compose -f local-docker-compose.yml down && MYSQL_VER=8.0 MINIO_VER=RELEASE.2022-08-11T04-37-28Z docker compose -f local-docker-compose.yml up --build --wait",
20+
"forwardPorts": [
21+
80,
22+
443,
23+
3306,
24+
8080,
25+
9000
26+
],
2027
"customizations": {
2128
"vscode": {
2229
"extensions": [

docs/src/develop.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,28 @@
22

33
Included with the codebase is the recommended development environment configured using [DevContainer](https://containers.dev/).
44

5-
## Launch Development Environment
5+
## Launch Environment
66

77
Here are some options that provide a great developer experience:
88

99
- **Cloud-based IDE**: (*recommended*)
1010
- Launch using [GitHub Codespaces](https://github.com/features/codespaces) using the option `Create codespace on master` in the codebase repository on your fork.
1111
- Build time for a 2-Core codespace is **~5m**. This is done infrequently and cached for convenience.
1212
- Start time for a 2-Core codespace is **~1m**. This will pull the built codespace from cache when you need it.
13-
- Tip: GitHub auto names the codespace but you can rename the codespace so that it is easier to identify later.
13+
- *Tip*: GitHub auto names the codespace but you can rename the codespace so that it is easier to identify later.
1414
- **Local IDE**:
1515
- Ensure you have [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
1616
- Ensure you have [Docker](https://docs.docker.com/get-docker/)
1717
- Ensure you have [VSCode](https://code.visualstudio.com/)
1818
- Install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
1919
- `git clone` the codebase repository and open it in VSCode
2020
- Use the `Dev Containers extension` to `Reopen in Container` (More info in the `Getting started` included with the extension)
21-
- Your environment will finish loading once the file tree is populated and the terminal become active
21+
22+
You will know your environment has finished loading once you see a terminal open related to `Running postStartCommand` with a final message: `Done`.
2223

2324
## Features
2425

25-
Once you've successfully launched the development environment, you'll be able to take advantage of our developer tooling to help improve productivity.
26+
Once you've successfully launched the development environment, you'll be able to take advantage of our developer tooling to help improve productivity and quality.
2627

2728
### Syntax Tests
2829

docs/src/tutorials/json.ipynb

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,18 @@
99
"# Using the `json` type"
1010
]
1111
},
12+
{
13+
"cell_type": "markdown",
14+
"id": "62450023",
15+
"metadata": {},
16+
"source": [
17+
"> ⚠️ Note the following before using the `json` type\n",
18+
"> - Supported only for MySQL >= 8.0 when [JSON_VALUE](https://dev.mysql.com/doc/refman/8.0/en/json-search-functions.html#function_json-value) introduced.\n",
19+
"> - Equivalent Percona is fully-compatible.\n",
20+
"> - MariaDB is not supported since [JSON_VALUE](https://mariadb.com/kb/en/json_value/#syntax) does not allow type specification like MySQL's.\n",
21+
"> - Not yet supported in DataJoint MATLAB"
22+
]
23+
},
1224
{
1325
"attachments": {},
1426
"cell_type": "markdown",
@@ -1046,7 +1058,7 @@
10461058
],
10471059
"metadata": {
10481060
"kernelspec": {
1049-
"display_name": "Python 3",
1061+
"display_name": "Python 3.10.4 64-bit",
10501062
"language": "python",
10511063
"name": "python3"
10521064
},
@@ -1060,11 +1072,11 @@
10601072
"name": "python",
10611073
"nbconvert_exporter": "python",
10621074
"pygments_lexer": "ipython3",
1063-
"version": "3.7.16"
1075+
"version": "3.10.4"
10641076
},
10651077
"vscode": {
10661078
"interpreter": {
1067-
"hash": "949777d72b0d2535278d3dc13498b2535136f6dfe0678499012e853ee9abcab1"
1079+
"hash": "31f2aee4e71d21fbe5cf8b01ff0e069b9275f58929596ceb00d14d90e3e16cd6"
10681080
}
10691081
}
10701082
},

0 commit comments

Comments
 (0)