Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion .docker/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
FROM datajoint/miniconda3:4.10.3-py3.9-alpine
ARG GITHUB_TOKEN
WORKDIR /main
COPY --chown=anaconda:anaconda ./.docker/pip_requirements.txt ${PIP_REQUIREMENTS}
RUN /entrypoint.sh echo "Dependencies installed"
COPY --chown=anaconda:anaconda ./.docker/apk_requirements.txt ${APK_REQUIREMENTS}
RUN \
/entrypoint.sh echo "Dependencies installed" && \
rm ${PIP_REQUIREMENTS} && \
rm ${APK_REQUIREMENTS}
RUN \
pip install --no-cache git+https://${GITHUB_TOKEN}@github.com/guzman-raphael/mkdocs-material-insiders.git@master || \
Comment thread
guzman-raphael marked this conversation as resolved.
echo "using public mkdocs-material..."
COPY --chown=anaconda:anaconda ./mkdocs.yaml /main/mkdocs.yaml
COPY --chown=anaconda:anaconda ./src /main/src
1 change: 1 addition & 0 deletions .docker/apk_requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
git
3 changes: 2 additions & 1 deletion .github/workflows/development.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ jobs:
env:
DOCKER_CLIENT_TIMEOUT: "120"
COMPOSE_HTTP_TIMEOUT: "120"
DJBOT_GH_TOKEN: ${{secrets.djbot_gh_token}}
steps:
- uses: actions/checkout@v2
- name: Compile docs static artifacts
run: |
MODE=BUILD HOST_UID=$(id -u) docker-compose up --exit-code-from docs --build
GITHUB_TOKEN=$DJBOT_GH_TOKEN MODE=BUILD HOST_UID=$(id -u) docker-compose up --exit-code-from docs --build
- name: Commit documentation changes
run: |
git clone https://github.com/${GITHUB_REPOSITORY}.git \
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
site
site
.env
2 changes: 2 additions & 0 deletions docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ services:
build:
dockerfile: .docker/Dockerfile
context: .
args:
- GITHUB_TOKEN
image: datajoint/datajoint-docs
environment:
- MODE
Expand Down
3 changes: 3 additions & 0 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,15 @@ plugins:
"index.md": "welcome.md"
markdown_extensions:
- attr_list
- md_in_html
- toc:
permalink: true
- pymdownx.emoji:
options:
custom_icons:
- .overrides/.icons
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- mdx_truly_sane_lists
- pymdownx.superfences:
custom_fences:
Expand Down
2 changes: 2 additions & 0 deletions src/.overrides/assets/stylesheets/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
/* ribbon */
/* ribbon + markdown heading expansion */
--md-primary-fg-color: var(--dj-black);
--md-primary-fg-color--dark: var(--dj-black);
/* ribbon text */
--md-primary-bg-color: var(--dj-primary);

Expand All @@ -36,6 +37,7 @@
/* ribbon */
/* ribbon + markdown heading expansion */
--md-primary-fg-color: var(--dj-primary);
--md-primary-fg-color--dark: var(--dj-primary);
/* ribbon text */
--md-primary-bg-color: var(--dj-white);

Expand Down
120 changes: 108 additions & 12 deletions src/core.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,58 @@ DataJoint Core projects are fully open-source and are built to develop, define,

## [API](https://en.wikipedia.org/wiki/API)'s

- **[DataJoint Python](https://datajoint.com/docs/core/datajoint-python/)**: A low-level client for managing [data pipelines](../glossary#data-pipeline).
- **[DataJoint MATLAB](https://datajoint.com/docs/core/datajoint-matlab/)**: A low-level client for managing [data pipelines](../glossary#data-pipeline).
- **[Pharus](https://datajoint.com/docs/core/pharus/)**: Expose [data pipelines](../glossary#data-pipeline) via a [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) interface.


<div class="grid cards" markdown>

- :fontawesome-brands-python:{ .lg .middle } **DataJoint Python**

---

A low-level client for managing [data pipelines](../glossary#data-pipeline).

[:octicons-arrow-right-24: Getting started](https://datajoint.com/docs/core/datajoint-python/)

- :fontawesome-brands-java:{ .lg .middle } **DataJoint MATLAB**

---

A low-level client for managing [data pipelines](../glossary#data-pipeline).

[:octicons-arrow-right-24: Getting started](https://datajoint.com/docs/core/datajoint-matlab/)

- :fontawesome-solid-flask:{ .lg .middle } **Pharus**

---

Expose [data pipelines](../glossary#data-pipeline) via a [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) interface.

[:octicons-arrow-right-24: Getting started](https://datajoint.com/docs/core/pharus/)

</div>

## Web [GUI](https://en.wikipedia.org/wiki/Graphical_user_interface)'s

- **[LabBook](https://datajoint.com/docs/core/datajoint-labbook/)**: Data entry and data model browsing for [data pipelines](../glossary#data-pipeline).
- **[SciViz](https://datajoint.com/docs/core/sci-viz/)**: A visualization framework for making [low-code](https://en.wikipedia.org/wiki/Low-code_development_platform) web apps for [data pipelines](../glossary#data-pipeline).

<div class="grid cards" markdown>

- :fontawesome-brands-chrome:{ .lg .middle } **LabBook**

---

Data entry and data model browsing for [data pipelines](../glossary#data-pipeline).

[:octicons-arrow-right-24: Getting started](https://datajoint.com/docs/core/datajoint-labbook/)

- :fontawesome-brands-chrome:{ .lg .middle } **SciViz**

---

A visualization framework for making [low-code](https://en.wikipedia.org/wiki/Low-code_development_platform) web apps for [data pipelines](../glossary#data-pipeline).

[:octicons-arrow-right-24: Getting started](https://datajoint.com/docs/core/sci-viz/)

</div>

## Container Images

Expand All @@ -25,10 +69,62 @@ graph
datajoint/djlab --> datajoint/djlabhub;
```

- **[datajoint/mysql](https://datajoint.com/docs/core/mysql-docker/)**: An optimized, MySQL backend for [data pipelines](../glossary#data-pipeline).
- **[datajoint/miniconda3](https://datajoint.com/docs/core/miniconda3-docker/)**: A minimal Python image with [conda](https://docs.conda.io/en/latest/).
- **[datajoint/djbase](https://datajoint.com/docs/core/djbase-docker/)**: Adds only dependencies for managing [data pipelines](../glossary#data-pipeline).
- **[datajoint/djtest](https://datajoint.com/docs/core/djtest-docker/)**: Adds testing tools like [pytest](https://docs.pytest.org/en/7.1.x/).
- **[datajoint/datajoint](https://datajoint.com/docs/core/datajoint-python/)**: Official image for managing [data pipelines](../glossary#data-pipeline).
- **[datajoint/djlab](https://datajoint.com/docs/core/djlab-docker/)**: Adds a local [Jupyter Lab](https://jupyterlab.readthedocs.io/en/stable/) environment.
- **[datajoint/djlabhub](https://datajoint.com/docs/core/djlabhub-docker/)**: Adds a client to allow hosting with [Jupyter Hub](https://jupyter.org/hub).
<div class="grid cards" markdown>

- :fontawesome-brands-docker:{ .lg .middle } **datajoint/mysql**

---

An optimized, MySQL backend for [data pipelines](../glossary#data-pipeline).

[:octicons-arrow-right-24: Getting started](https://datajoint.com/docs/core/mysql-docker/)

- :fontawesome-brands-docker:{ .lg .middle } **datajoint/miniconda3**

---

A minimal Python image with [conda](https://docs.conda.io/en/latest/).

[:octicons-arrow-right-24: Getting started](https://datajoint.com/docs/core/miniconda3-docker/)

- :fontawesome-brands-docker:{ .lg .middle } **datajoint/djbase**

---

Adds only dependencies for managing [data pipelines](../glossary#data-pipeline).

[:octicons-arrow-right-24: Getting started](https://datajoint.com/docs/core/djbase-docker/)

- :fontawesome-brands-docker:{ .lg .middle } **datajoint/djtest**

---

Adds testing tools like [pytest](https://docs.pytest.org/en/7.1.x/).

[:octicons-arrow-right-24: Getting started](https://datajoint.com/docs/core/djtest-docker/)

- :fontawesome-brands-docker:{ .lg .middle } **datajoint/datajoint**

---

Official image for managing [data pipelines](../glossary#data-pipeline).

[:octicons-arrow-right-24: Getting started](https://datajoint.com/docs/core/datajoint-python/)
Comment thread
dimitri-yatsenko marked this conversation as resolved.

- :fontawesome-brands-docker:{ .lg .middle } **datajoint/djlab**

---

Adds a local [Jupyter Lab](https://jupyterlab.readthedocs.io/en/stable/) environment.

[:octicons-arrow-right-24: Getting started](https://datajoint.com/docs/core/djlab-docker/)

- :fontawesome-brands-docker:{ .lg .middle } **datajoint/djlabhub**

---

Adds a client to allow hosting with [Jupyter Hub](https://jupyter.org/hub).

[:octicons-arrow-right-24: Getting started](https://datajoint.com/docs/core/djlabhub-docker/)

</div>