Skip to content

Commit d8ecab1

Browse files
Merge pull request #51 from kabilar/main
Migrate `Core` documentation to `datajoint-python/docs`
2 parents 80847df + 46770a9 commit d8ecab1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+21
-1257
lines changed

mkdocs.yaml

Lines changed: 3 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -6,76 +6,21 @@ repo_name: datajoint-company/datajoint-docs
66
repo_url: https://github.com/datajoint-company/datajoint-docs
77
nav:
88
- Welcome: index.md
9-
- Core:
10-
- core/index.md
11-
- Concepts:
12-
- Principles: core/concepts/principles.md
13-
- Glossary: core/concepts/glossary.md
14-
- System Administration:
15-
- Database Administration: core/sysadmin/dba.md
16-
- File Storage: core/sysadmin/filestore.md
17-
- Client Configuration:
18-
- Install: core/client/install.md
19-
- Credentials: core/client/creds.md
20-
- Settings: core/client/settings.md
21-
- File stores: core/client/stores.md
22-
- Schema Design:
23-
- Schema Creation: core/design/schema.md
24-
- Table Definition:
25-
- Table tiers: core/design/tables/tiers.md
26-
- Declaration Syntax: core/design/tables/declare.md
27-
- Primary Key: core/design/tables/primary.md
28-
- Attributes: core/design/tables/attributes.md
29-
- Lookup Tables: core/design/tables/lookup.md
30-
- Blobs: core/design/tables/blobs.md
31-
- Attachments: core/design/tables/attach.md
32-
- Filepaths: core/design/tables/filepath.md
33-
- Custom Datatypes: core/design/tables/customtype.md
34-
- Dependencies: core/design/tables/dependencies.md
35-
- Indexes: core/design/tables/indexes.md
36-
- Master-Part Relationships: core/design/tables/master-part.md
37-
- Schema Diagrams: core/design/diagrams.md
38-
- Entity Normalization: core/design/normalization.md
39-
- Data Integrity: core/design/integrity.md
40-
- Schema Recall: core/design/recall.md
41-
- Schema Drop: core/design/drop.md
42-
- Schema Modification: core/design/alter.md
43-
- Data Manipulations:
44-
- Insert: core/manipulation/insert.md
45-
- Delete: core/manipulations/delete.md
46-
- Update: core/manipulations/update.md
47-
- Transactions: core/manipulations/transactions.md
48-
- Data queries:
49-
- Query principles: core/query/operators.md
50-
- Fetch: core/query/fetch.md
51-
- Restrict: core/query/restrict.md
52-
- Projection: core/query/project.md
53-
- Join: core/query/join.md
54-
- Aggregation: core/query/aggregation.md
55-
- Union: core/query/union.md
56-
- Universal Sets: core/query/universals.md
57-
- Computations:
58-
- Make Method: core/compute/make.md
59-
- Populate: core/compute/populate.md
60-
- Key Source: core/compmute/keysource.md
61-
- Distributed Computing: core/compute/distributed.md
62-
- Internals:
63-
- SQL transpilation: core/internal/transpilation.md
64-
- FAQ: core/faq.md
9+
- DataJoint Python: core/datajoint-python/
6510
- Elements:
6611
- elements/index.md
6712
- Concepts: elements/concepts.md
6813
- User Guide: elements/user-guide.md
6914
- Developer Guide: elements/developer-guide.md
7015
- Management:
7116
- Plan: elements/management/plan.md
72-
- Team: elements/management/team.md
7317
- Governance: elements/management/governance.md
7418
- Selection: elements/management/selection.md
7519
- Quality Assurance: elements/management/quality-assurance.md
7620
- Outreach: elements/management/outreach.md
7721
- Dissemination: elements/management/dissemination.md
7822
- Adoption: elements/management/adoption.md
23+
- Additional Resources: additional-resources.md
7924
- Projects: projects.md
8025
- Publications: publications.md
8126
- Citation: citation.md
@@ -84,6 +29,7 @@ nav:
8429
- Events: community/events.md
8530
- Contribute: community/contribute.md
8631
- Licenses: community/licenses.md
32+
- Team: community/team.md
8733
- History: community/history.md
8834
- Partnership - DANDI: community/partnership-dandi.md
8935
- Partnership - Facemap: community/partnership-facemap.md
Lines changed: 11 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,40 @@
1-
# Core
1+
# Additional Resources
22

3-
DataJoint Core is a collection of open-source tools for building and operating scientific data pipelines.
3+
A collection of additional open-source tools for building and operating scientific data pipelines.
44

5-
## APIs
5+
## API
66

77
<div class="grid cards" markdown>
88

9-
- :fontawesome-brands-python:{ .lg .middle } **DataJoint for Python**
10-
11-
---
12-
13-
A Python client for defining, operating, and querying data pipelines.
14-
15-
[:octicons-arrow-right-24: Interactive tutorial on GitHub Codespaces](https://github.com/datajoint/datajoint-tutorials){:target="_blank"}
16-
17-
:octicons-arrow-right-24: [New docs](./datajoint-python/) coming soon! In the meantime, refer to our [legacy docs](https://docs.datajoint.org/python/).
18-
199
- :fontawesome-brands-java:{ .lg .middle } **DataJoint for MATLAB**
2010

2111
---
2212

2313
A MATLAB client for defining, operating, and querying data pipelines.
2414

25-
:octicons-arrow-right-24: [Documentation](https://datajoint.com/docs/core/datajoint-matlab) | [Source code](https://github.com/datajoint/datajoint-matlab)
15+
:octicons-arrow-right-24: [Legacy docs](https://docs.datajoint.org/matlab/) | [Source code](https://github.com/datajoint/datajoint-matlab)
2616

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

2919
---
3020

3121
A REST API server for interacting with DataJoint pipelines.
3222

33-
:octicons-arrow-right-24: New docs coming soon! In the meantime, refer to our [legacy docs](./pharus/).
34-
35-
:octicons-arrow-right-24: [Documentation](https://datajoint.github.io/pharus/) | [Source code](https://github.com/datajoint/pharus/)
23+
:octicons-arrow-right-24: [Legacy docs](https://datajoint.github.io/pharus/) | [Source code](https://github.com/datajoint/pharus/)
3624

3725
</div>
3826

3927
## Web Applications
4028

4129
<div class="grid cards" markdown>
4230

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

4633
---
4734

48-
A browser-based graphical user interface for data entry and navigation.
35+
A browser-based graphical user interface for data entry and navigation.
4936

50-
:octicons-arrow-right-24: [Documentation](https://datajoint.github.io/datajoint-labbook/) | [Source code](https://github.com/datajoint/datajoint-labbook/)
37+
:octicons-arrow-right-24: [Legacy docs](https://datajoint.github.io/datajoint-labbook/) | [Source code](https://github.com/datajoint/datajoint-labbook/)
5138

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

@@ -86,7 +73,7 @@ graph
8673
---
8774
MySQL server pre-configured to work smoothly with DataJoint.
8875

89-
:octicons-arrow-right-24: New docs coming soon! In the meantime, refer to our [legacy docs](https://github.com/datajoint/mysql-docker#mysql-for-datajoint).
76+
:octicons-arrow-right-24: [Legacy docs](https://github.com/datajoint/mysql-docker#mysql-for-datajoint).
9077

9178
- :fontawesome-brands-docker:{ .lg .middle } [**datajoint/miniconda3**](https://hub.docker.com/r/datajoint/miniconda3)
9279

@@ -112,20 +99,18 @@ graph
11299

113100
Official DataJoint Docker image.
114101

115-
:octicons-arrow-right-24: [New docs](./datajoint-python/) coming soon! In the meantime, refer to our [legacy docs](https://docs.datajoint.org/python/).
102+
:octicons-arrow-right-24: [Legacy docs](https://docs.datajoint.org/python/).
116103

117104
- :fontawesome-brands-docker:{ .lg .middle } [**datajoint/djlab**](https://hub.docker.com/r/datajoint/djlab)
118105

119106
---
120107

121-
A docker image optimized for running a JupyterLab environment with DataJoint Python.
122-
108+
A docker image optimized for running a JupyterLab environment with DataJoint Python.
123109

124110
- :fontawesome-brands-docker:{ .lg .middle } [**datajoint/djlabhub**](https://hub.docker.com/r/datajoint/djlabhub)
125111

126112
---
127113

128-
A docker image optimized for deploying to JupyterHub a JupyterLab environment with DataJoint Python.
129-
114+
A docker image optimized for deploying to JupyterHub a JupyterLab environment with DataJoint Python.
130115

131116
</div>
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ as Principal Investigator.
1414

1515
## Engineers
1616

17-
- Raphael Guzman - Software Engineer
1817
- Drew Yang - Data Systems Engineer
1918
- Jeroen Verswijver - Software Engineer
2019
- Adib Baji - Software Engineer
@@ -29,6 +28,7 @@ as Principal Investigator.
2928
- Joseph Burling - Data Scientist
3029
- Chris Brozdowski - Data Scientist
3130
- Tolga Dincer - Data Scientist
31+
- Raphael Guzman - Software Engineer
3232
- Maho Sasaki - Software Engineer
3333
- Daniel Sitonic - Software Engineer
3434
- Carlos Ortiz - Software Engineer
@@ -44,5 +44,5 @@ The first-person pronouns "we" and "our" in these documents refer to those liste
4444

4545
The principal components of the Resource are developed and distributed as open-source
4646
projects and external contributions are welcome. We have adopted a
47-
[Contribution Guide](../../../community/contribute) for DataJoint, DataJoint Elements,
47+
[Contribution Guide](.contribute) for DataJoint, DataJoint Elements,
4848
and related open-source tools.

src/core/client/creds.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

src/core/client/install.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

src/core/client/settings.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

src/core/client/stores.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

src/core/compute/distributed.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

src/core/compute/keysource.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

src/core/compute/make.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

0 commit comments

Comments
 (0)