Skip to content

Commit 42ddcb5

Browse files
author
Drew Yang
committed
feat: ✨ update url reference from datajoint.com/docs/ to docs.datajoint.com
1 parent db09125 commit 42ddcb5

File tree

9 files changed

+28
-40
lines changed

9 files changed

+28
-40
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# DataJoint Documentation
22

3-
This is the home for DataJoint software documentation as hosted at https://datajoint.com/docs
4-
3+
This is the home for DataJoint software documentation as hosted at https://docs.datajoint.com
54
## VSCode Linter Extensions and Settings
65

76
The following extensions were used in developing these docs, with the corresponding
@@ -39,7 +38,7 @@ Then install the required packages:
3938
pip install -r pip_requirements.txt
4039
```
4140

42-
Run mkdocs at: http://127.0.0.1:8000/docs/
41+
Run mkdocs at: http://127.0.0.1:8000/
4342
```bash
4443
# It will automatically reload the docs when changes are made
4544
mkdocs serve --config-file ./mkdocs.yaml
@@ -57,7 +56,7 @@ Then run the following:
5756
MODE="LIVE" docker compose up --build
5857
```
5958

60-
Navigate to http://127.0.0.1:8000/docs/ to preview the changes.
59+
Navigate to http://127.0.0.1:8000/ to preview the changes.
6160

6261
This setup supports live-reloading so all that is needed is to save the markdown files
6362
and/or `mkdocs.yaml` file to trigger a reload.
@@ -77,10 +76,9 @@ INFO - Doc file 'index.md' contains an unrecognized relative link './core/da
7776
- You hit `datajoint.com/*` on your browser
7877
- It'll bring you to the reverse proxy server first, that you wouldn't notice
7978
- when your URL ends with:
80-
- `/` is the company page
81-
- `/docs/` is the landing/navigation page hosted by datajoint/datajoint-docs's github pages
82-
- `/docs/core/datajoint-python/` is the actual docs site hosted by datajoint/datajoint-python's github pages
83-
- `/docs/elements/element-*/` is the actual docs site hosted by each element's github pages
79+
- `/` is the landing/navigation page hosted by datajoint/datajoint-docs's github pages
80+
- `/core/datajoint-python/` is the actual docs site hosted by datajoint/datajoint-python's github pages
81+
- `/elements/element-*/` is the actual docs site hosted by each element's github pages
8482

8583

8684
```log

docker-compose.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MODE="LIVE|BUILD" docker compose up --build
22
#
3-
# Navigate to http://localhost/docs/
3+
# Navigate to http://localhost:8000/
44
services:
55
docs:
66
# image: datajoint/datajoint-docs

src/additional-resources.md

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ A collection of additional open-source tools for building and operating scientif
1212

1313
A MATLAB client for defining, operating, and querying data pipelines.
1414

15-
:octicons-arrow-right-24: [Legacy docs](https://docs.datajoint.org/matlab/) |
15+
:octicons-arrow-right-24: [Legacy docs](https://datajoint.github.io/datajoint-docs-original/matlab/) |
1616
[Source code](https://github.com/datajoint/datajoint-matlab)
1717

1818
- :fontawesome-solid-flask:{ .lg .middle } **DataJoint Pharus**
@@ -21,7 +21,7 @@ A collection of additional open-source tools for building and operating scientif
2121

2222
A REST API server for interacting with DataJoint pipelines.
2323

24-
:octicons-arrow-right-24: [Docs](https://datajoint.com/docs/core/pharus) |
24+
:octicons-arrow-right-24: [Docs](https://docs.datajoint.com/core/pharus) |
2525
[Source code](https://github.com/datajoint/pharus/)
2626

2727
</div>
@@ -36,8 +36,7 @@ A collection of additional open-source tools for building and operating scientif
3636

3737
A browser-based graphical user interface for data entry and navigation.
3838

39-
:octicons-arrow-right-24: [Legacy
40-
docs](https://datajoint.com/docs/core/datajoint-labbook/) |
39+
:octicons-arrow-right-24: [Legacy docs](https://datajoint.github.io/datajoint-labbook/) |
4140
[Source code](https://github.com/datajoint/datajoint-labbook/)
4241

4342
- :fontawesome-brands-chrome:{ .lg .middle } **DataJoint SciViz**
@@ -46,7 +45,7 @@ A collection of additional open-source tools for building and operating scientif
4645

4746
A framework for making low-code web apps for data visualization.
4847

49-
:octicons-arrow-right-24: [Legacy docs](https://datajoint.com/docs/core/sci-viz/) |
48+
:octicons-arrow-right-24: [Docs](https://docs.datajoint.com/core/sci-viz/) |
5049
[Source code](https://github.com/datajoint/sci-viz)
5150

5251
</div>
@@ -78,8 +77,7 @@ graph
7877
---
7978
MySQL server configured to work with DataJoint.
8079

81-
:octicons-arrow-right-24: [Docker
82-
image](https://hub.docker.com/r/datajoint/mysql) |
80+
:octicons-arrow-right-24: [Docker image](https://hub.docker.com/r/datajoint/mysql) |
8381
[Source code](https://github.com/datajoint/mysql-docker)
8482

8583
- :fontawesome-brands-docker:{ .lg .middle } **datajoint/miniconda3**
@@ -88,8 +86,7 @@ graph
8886

8987
Minimal Python Docker image with [conda](https://docs.conda.io/en/latest/).
9088

91-
:octicons-arrow-right-24: [Docker
92-
image](https://hub.docker.com/r/datajoint/miniconda3) |
89+
:octicons-arrow-right-24: [Docker image](https://hub.docker.com/r/datajoint/miniconda3) |
9390
[Legacy docs](https://datajoint.github.io/miniconda3-docker/) |
9491
[Source code](https://github.com/datajoint/miniconda3-docker)
9592

@@ -99,8 +96,7 @@ graph
9996

10097
Minimal base Docker image with DataJoint Python dependencies installed.
10198

102-
:octicons-arrow-right-24: [Docker
103-
image](https://hub.docker.com/r/datajoint/djbase) |
99+
:octicons-arrow-right-24: [Docker image](https://hub.docker.com/r/datajoint/djbase) |
104100
[Legacy docs](https://datajoint.github.io/djbase-docker/) |
105101
[Source code](https://github.com/datajoint/djbase-docker)
106102

@@ -110,8 +106,7 @@ graph
110106

111107
Docker image for running tests related to DataJoint Python.
112108

113-
:octicons-arrow-right-24: [Docker
114-
image](https://hub.docker.com/r/datajoint/djtest) |
109+
:octicons-arrow-right-24: [Docker image](https://hub.docker.com/r/datajoint/djtest) |
115110
[Legacy docs](https://datajoint.github.io/djtest-docker/) |
116111
[Source code](https://github.com/datajoint/djtest-docker)
117112

@@ -121,8 +116,7 @@ graph
121116

122117
Official DataJoint Docker image.
123118

124-
:octicons-arrow-right-24: [Docker
125-
image](https://hub.docker.com/r/datajoint/datajoint) |
119+
:octicons-arrow-right-24: [Docker image](https://hub.docker.com/r/datajoint/datajoint) |
126120
[Source code](https://github.com/datajoint/datajoint-python)
127121

128122
- :fontawesome-brands-docker:{ .lg .middle } **datajoint/djlab**
@@ -131,9 +125,7 @@ graph
131125

132126
Docker image optimized for running a JupyterLab environment with DataJoint Python.
133127

134-
:octicons-arrow-right-24: [Docker
135-
image](https://hub.docker.com/r/datajoint/djlab) |
136-
[Legacy docs](https://datajoint.github.io/djlab-docker/) |
128+
:octicons-arrow-right-24: [Docker image](https://hub.docker.com/r/datajoint/djlab) |
137129
[Source code](https://github.com/datajoint/djlab-docker)
138130

139131
- :fontawesome-brands-docker:{ .lg .middle } **datajoint/djlabhub**
@@ -143,9 +135,7 @@ graph
143135
Docker image optimized for deploying to JupyterHub a JupyterLab environment with
144136
DataJoint Python.
145137

146-
:octicons-arrow-right-24: [Docker
147-
image](https://hub.docker.com/r/datajoint/djlabhub) |
148-
[Legacy docs](https://datajoint.github.io/djlabhub-docker/) |
138+
:octicons-arrow-right-24: [Docker image](https://hub.docker.com/r/datajoint/djlabhub) |
149139
[Source code](https://github.com/datajoint/djlabhub-docker)
150140

151141
</div>

src/elements/management/dissemination.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
We conduct activities to disseminate Resource components for adoption in diverse
66
neuroscience labs. These activities include
77

8-
- A central [website](https://datajoint.com/docs/elements/) for the Resource.
8+
- A central [website](https://docs.datajoint.com/elements/) for the Resource.
99
- [Conference talks, presentations, and workshops](../../support-events.md)
1010
- Publications in peer-reviewed journals
1111
- White papers posted on internet resources and websites

src/partnerships/dandi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ integration and interoperability across the two ecosystems.
2020

2121
### DataJoint
2222

23-
**DataJoint Elements**https://datajoint.com/docs/elements/ — is a collection of
23+
**DataJoint Elements**https://docs.datajoint.com/elements/ — is a collection of
2424
open-source reference database schemas and analysis workflows for neurophysiology
25-
experiments, supported by **DataJoint**https://datajoint.com/docs/core/ — an
25+
experiments, supported by **DataJoint**https://docs.datajoint.com/core/ — an
2626
open-source software framework. The project is funded by the NIH grant U24 NS116470
2727
and led by Dr. Dimitri Yatsenko.
2828

src/partnerships/facemap.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ across the two ecosystems.
2020

2121
### DataJoint
2222

23-
**DataJoint Elements**https://datajoint.com/docs/elements/ — is a collection of
23+
**DataJoint Elements**https://docs.datajoint.com/elements/ — is a collection of
2424
open-source reference database schemas and analysis workflows for neurophysiology
25-
experiments, supported by **DataJoint**https://datajoint.com/docs/core/ — an
25+
experiments, supported by **DataJoint**https://docs.datajoint.com/core/ — an
2626
open-source software framework. The project is funded by the NIH grant U24 NS116470
2727
and led by Dr. Dimitri Yatsenko.
2828

src/partnerships/nwb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@
2020

2121
### DataJoint
2222

23-
**DataJoint Elements**https://datajoint.com/docs/elements/ — is a collection of
23+
**DataJoint Elements**https://docs.datajoint.com/elements/ — is a collection of
2424
open-source reference database schemas and analysis workflows for neurophysiology
25-
experiments, supported by **DataJoint**https://datajoint.com/docs/core/ — an
25+
experiments, supported by **DataJoint**https://docs.datajoint.com/core/ — an
2626
open-source software framework. The project is funded by the NIH grant U24 NS116470
2727
and led by Dr. Dimitri Yatsenko.
2828

src/partnerships/openephysgui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
### DataJoint
1818

19-
**DataJoint Elements**https://datajoint.com/docs/elements/ — is a collection of open-source reference database schemas and analysis workflows for neurophysiology experiments, supported by **DataJoint Core**https://datajoint.com/docs/core/ — an open-source software framework. The project is funded by the NIH grant U24 NS116470 and led by Dr. Dimitri Yatsenko.
19+
**DataJoint Elements**https://docs.datajoint.com/elements/ — is a collection of open-source reference database schemas and analysis workflows for neurophysiology experiments, supported by **DataJoint Core**https://docs.datajoint.com/core/ — an open-source software framework. The project is funded by the NIH grant U24 NS116470 and led by Dr. Dimitri Yatsenko.
2020

2121
The principal developer of DataJoint Elements and DataJoint Core is the company
2222
DataJoint — https://datajoint.com.

src/partnerships/suite2p.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@
2020

2121
### DataJoint
2222

23-
**DataJoint Elements**https://datajoint.com/docs/elements/ — is a collection of
23+
**DataJoint Elements**https://docs.datajoint.com/elements/ — is a collection of
2424
open-source reference database schemas and analysis workflows for neurophysiology
25-
experiments, supported by **DataJoint**https://datajoint.com/docs/core/ — an
25+
experiments, supported by **DataJoint**https://docs.datajoint.com/core/ — an
2626
open-source software framework. The project is funded by the NIH grant U24 NS116470
2727
and led by Dr. Dimitri Yatsenko.
2828

0 commit comments

Comments
 (0)