Skip to content

fix: update home URL from datajoint.com/docs to docs.datajoint.com #1237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 19, 2025
Merged

fix: update home URL from datajoint.com/docs to docs.datajoint.com #1237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb0ee7d
fix: Update home URL from `datajoint.com/docs` to `docs.datajoint.com`
MilagrosMarin May 15, 2025
557e11a
fix: typo for codespell
MilagrosMarin May 15, 2025
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
37 changes: 18 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
<tr>
<td>Doc Status</td>
<td>
<a href="https://datajoint.com/docs">
<a href="https://docs.datajoint.com">
<img src="https://github.com/datajoint/datajoint-python/actions/workflows/pages/pages-build-deployment/badge.svg" alt="doc status" />
</a>
</td>
Expand All @@ -68,12 +68,12 @@
</td>
</tr>
<tr>
<td>Developer Chat</td>
<td>
<a href="https://datajoint.slack.com/">
<td>Developer Chat</td>
<td>
<a href="https://datajoint.slack.com/">
<img src="https://img.shields.io/badge/slack-datajoint-purple.svg" alt="datajoint slack"/>
</a>
</td>
</a>
</td>
</tr>
<tr>
<td>License</td>
Expand All @@ -84,21 +84,20 @@
</td>
</tr>
<tr>
<td>Citation</td>
<td>
<a href="https://doi.org/10.1101/031658">
<img src="https://img.shields.io/badge/DOI-10.1101/bioRxiv.031658-B31B1B.svg" alt="bioRxiv">
</a>
<td>Citation</td>
<td>
<a href="https://doi.org/10.1101/031658">
<img src="https://img.shields.io/badge/DOI-10.1101/bioRxiv.031658-B31B1B.svg" alt="bioRxiv">
</a>
<br>
<a href="https://doi.org/10.5281/zenodo.6829062">
<img src="https://zenodo.org/badge/DOI/10.5281/zenodo.6829062.svg" alt="zenodo">
</a>
</td>
</a>
</td>
</tr>

</table>


DataJoint for Python is a framework for scientific workflow management based on
relational principles. DataJoint is built on the foundation of the relational data
model and prescribes a consistent method for organizing, populating, computing, and
Expand All @@ -110,7 +109,7 @@ volumes of data streaming from regular experiments. Starting in 2011, DataJoint
been available as an open-source project adopted by other labs and improved through
contributions from several developers.
Presently, the primary developer of DataJoint open-source software is the company
DataJoint (https://datajoint.com).
DataJoint (<https://datajoint.com>).

## Data Pipeline Example

Expand All @@ -132,13 +131,13 @@ DataJoint (https://datajoint.com).
pip install datajoint
```

- [Documentation & Tutorials](https://datajoint.com/docs/core/datajoint-python/)
- [Documentation & Tutorials](https://docs.datajoint.com/core/datajoint-python/)

- [Interactive Tutorials](https://github.com/datajoint/datajoint-tutorials) on GitHub Codespaces

- [DataJoint Elements](https://datajoint.com/docs/elements/) - Catalog of example pipelines for neuroscience experiments
- [DataJoint Elements](https://docs.datajoint.com/elements/) - Catalog of example pipelines for neuroscience experiments

- Contribute
- [Contribution Guidelines](https://datajoint.com/docs/about/contribute/)
- [Contribution Guidelines](https://docs.datajoint.com/about/contribute/)

- [Developer Guide](https://datajoint.com/docs/core/datajoint-python/latest/develop/)
- [Developer Guide](https://docs.datajoint.com/core/datajoint-python/latest/develop/)
2 changes: 1 addition & 1 deletion datajoint/diagram.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class Diagram:
Entity relationship diagram, currently disabled due to the lack of required packages: matplotlib and pygraphviz.

To enable Diagram feature, please install both matplotlib and pygraphviz. For instructions on how to install
these two packages, refer to https://datajoint.com/docs/core/datajoint-python/0.14/client/install/
these two packages, refer to https://docs.datajoint.com/core/datajoint-python/0.14/client/install/
"""

def __init__(self, *args, **kwargs):
Expand Down
5 changes: 2 additions & 3 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contribute to DataJoint Documentation

This is the home for DataJoint software documentation as hosted at https://datajoint.com/docs/core/datajoint-python/latest/
This is the home for DataJoint software documentation as hosted at https://docs.datajoint.com/core/datajoint-python/latest/.

## VSCode Linter Extensions and Settings

Expand Down Expand Up @@ -89,9 +89,8 @@ INFO - Doc file 'index.md' contains an unrecognized relative link './develop
- `/docs/core/datajoint-python/` is the actual docs site hosted by datajoint/datajoint-python's github pages
- `/docs/elements/element-*/` is the actual docs site hosted by each element's github pages


```log
WARNING - Doc file 'query/operators.md' contains a link '../../../images/concepts-operators-restriction.png', but
the target '../../images/concepts-operators-restriction.png' is not found among documentation files.
```
- We use Github Pages to host our docs, the image references needs to follow the mkdocs's build directory structure, under `site/` directory once you run mkdocs.
- We use Github Pages to host our docs, the image references needs to follow the mkdocs's build directory structure, under `site/` directory once you run mkdocs.
2 changes: 1 addition & 1 deletion docs/src/design/tables/indexes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To make searches faster on fields other than the primary key or a foreign key, y
add a secondary index explicitly.

Regular indexes are declared as `index(attr1, ..., attrN)` on a separate line anywhere in
the table declration (below the primary key divide).
the table declaration (below the primary key divide).

Indexes can be declared with unique constraint as `unique index (attr1, ..., attrN)`.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ source project for data entry but is no longer actively maintained.

## Does DataJoint support other programming languages?

DataJoint [Python](https://datajoint.com/docs/core/datajoint-python/) is the most
DataJoint [Python](https://docs.datajoint.com/core/datajoint-python/) is the most
up-to-date version and all future development will focus on the Python API. The
[Matlab](https://datajoint.com/docs/core/datajoint-matlab/) API was actively developed
through 2023. Previous projects implemented some DataJoint features in
Expand Down
4 changes: 2 additions & 2 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ Presently, the primary developer of DataJoint open-source software is the compan

- [Interactive Tutorials](https://github.com/datajoint/datajoint-tutorials){:target="_blank"} on GitHub Codespaces

- [DataJoint Elements](https://datajoint.com/docs/elements/) - Catalog of example pipelines for neuroscience experiments
- [DataJoint Elements](https://docs.datajoint.com/elements/) - Catalog of example pipelines for neuroscience experiments

- Contribute
- [Development Environment](./develop)

- [Guidelines](https://datajoint.com/docs/community/contribute/)
- [Guidelines](https://docs.datajoint.com/about/contribute/)
2 changes: 1 addition & 1 deletion docs/src/query/operators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,4 +392,4 @@ dj.U().aggr(Session, n="max(session)") # (3)

`dj.U()`, as shown in the last example above, is often useful for integer IDs.
For an example of this process, see the source code for
[Element Array Electrophysiology's `insert_new_params`](https://datajoint.com/docs/elements/element-array-ephys/latest/api/element_array_ephys/ephys_acute/#element_array_ephys.ephys_acute.ClusteringParamSet.insert_new_params).
[Element Array Electrophysiology's `insert_new_params`](https://docs.datajoint.com/elements/element-array-ephys/latest/api/element_array_ephys/ephys_acute/#element_array_ephys.ephys_acute.ClusteringParamSet.insert_new_params).
Loading
Loading