Skip to content

Commit 0abb2ef

Browse files
committed
docs: preparing more skeleton, updating /docs page
1 parent cec9355 commit 0abb2ef

8 files changed

Lines changed: 49 additions & 13 deletions

File tree

docs/source/acquire_upload.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88

99
[Upload my data assets](acquire_upload/upload.md) to the Cloud.
1010

11+
[Process my data assets](acquire_upload/processing.md) using our per-modality standard pipelines.
12+
1113
```{toctree}
1214
:hidden:
1315
Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# On rig
22

3-
[TODO]
3+
During data acquisition you are responsible for running version-controlled acquisition software and ensuring your data files are organized according to a standardized system. Metadata generated during acquisition captures **what data** should appear in the final NWB files after processing, as well as **what manipulations** were performed (both behavioral stimuli and any procedures).
4+
5+
## Data file standards
6+
7+
Raw data assets should be organized by modality.
8+
9+
##
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Per-modality pipelines
2+

docs/source/docs.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,29 @@
1-
# Documentation Guidelines
1+
# Documentation guidelines
22

33
## What
44

5-
As a developer you are responsible for providing four kinds of documentation: **tutorials** for beginners learning how to use a tool, **how-to guides** for achieving specific goals, technical **reference** for understanding software, and **explanation** for understanding why tools were built the way they are.
5+
As a developer you are responsible for providing four kinds of documentation: **tutorials** for beginners learning how to use a tool, **how-to guides** for achieving specific goals, technical **reference** for understanding software, and **explanation** for understanding why tools were built the way they are. Our documentation is organized according to the [diataxis](https://diataxis.fr/) framework.
66

7+
At a minimum, you must provide a technical **reference** in the `README.md` file in every GitHub repository that you maintain and update the standard headers in the [aind-library-template](https://github.com/AllenNeuralDynamics/aind-library-template): Usage, Level of Support, Installation.
78

9+
All packages should include:
810

9-
## Where
11+
1. A **tutorial** aimed at total beginners using your package that walks them through a basic example.
12+
2. **How-to guides** for specific use-cases of your package. Note that AIND-specific use cases should be documented in [aind-software-docs](https://github.com/AllenNeuralDynamics/aind-software-docs).
1013

11-
| Location | Type | User | Details |
12-
|----------|------|------|---------|
13-
| [aind-software-docs](https://github.com/AllenNeuralDynamics/aind-software-docs) | Tutorials | New users | User stories, tutorials, and links to technical documentation |
14-
| Documentation pages for your repository | How-to Guides | Technical users | Technical details about a library |
15-
| Documentation pages for your repository | Reference | Developers | Developer documentation, contributing guidelines, and deployment details |
16-
| Talks, project proposals, white papers, documentation pages for your repository | Explanation | Developers | Why we did things the way we did |
14+
For packages that are fully released you should also add:
1715

18-
## How
16+
3. **Technical reference**, generally auto-generated library or API docs.
17+
4. **Explanation** of technical or philosophical decisions made during development. Links to a preprint or paper can often take the place of an explanation section.
18+
19+
As an example, on the [aind-data-schema documentation](https://aind-data-schema.readthedocs.io/en/latest/example_workflow/example_workflow.html) the [Generating metadata](https://aind-data-schema.readthedocs.io/en/latest/example_workflow/example_workflow.html) section is a tutorial, the [Core and Component Schemas](https://aind-data-schema.readthedocs.io/en/latest/data_description.html) pages are reference, and the [Philosophy](https://aind-data-schema.readthedocs.io/en/latest/general.html) sections provide some explanation of *why* certain decisions were made.
1920

20-
You can contribute directly to this repository with a pull request and review.
21+
## How
2122

2223
Libraries built using the `aind-library-template` automatically have a read-the-docs documentation built-in. You can write `.rst` files or add the `myst-parser` package and write `.md` files. You can deploy your documentation directly on the [read-the-docs](https://readthedocs.org).
2324

25+
You can contribute updates and how-to guides for your tools directly to this repository with a pull request and review.
26+
2427
## Why
2528

26-
[Diataxis](https://diataxis.fr/)
29+
Software engineer at AIND has grown to a scale where a central entry-point for users should make it far easier to find and learn about our tools. Across packages we are also taking a variety of approaches to documentation, iteratively moving toward a more standardized "feel" in our documentation will reduce the overhead for users who are only rarely interacting with documentation during their scientific work.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Analysis framework
2+
3+
The [Analysis Framework](https://codeocean.allenneuraldynamics.org/capsule/3390834/tree/v1) is a Code Ocean pipeline that provides a template for facilitating large-scale analysis for data assets. Use the analysis framework anytime your analysis capsule(s) need to be run at scale on many individual data assets.

docs/source/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
[Propose a project](proposals.md) with scientific computing support.
1212

13+
[Publish and share](share.md) my data with external users.
14+
1315
## I need to report an...
1416

1517
[Issue with scientific computing software](https://github.com/AllenNeuralDynamics/aind-scientific-computing/).
@@ -24,6 +26,10 @@ Follow these links to request access to:
2426
- [GitHub Copilot](https://alleninstitute.service-now.com/sp?id=sc_cat_item&sys_id=83bc1726477aa91032b789b5536d430e&referrer=popular_items) - via ServiceNow
2527
- [VAST /allen/aind/scratch and /allen/aind/stage](https://alleninstitute.service-now.com/sp?id=sc_cat_item&sys_id=83bc1726477aa91032b789b5536d430e&referrer=popular_items) - via ServiceNow
2628

29+
## I want to learn about...
30+
31+
[Data governance](phil)
32+
2733
```{toctree}
2834
:maxdepth: 2
2935
:hidden:
@@ -32,6 +38,7 @@ Follow these links to request access to:
3238
acquire_upload
3339
explore_analyze
3440
proposals
41+
share
3542
3643
```
3744

@@ -40,6 +47,16 @@ proposals
4047
:hidden:
4148
:caption: Resources
4249
50+
docs
4351
core_services
4452
4553
```
54+
55+
```{toctree}
56+
:maxdepth: 1
57+
:hidden:
58+
:caption: Philosophy
59+
60+
philosophy
61+
62+
```

docs/source/philosophy.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Data philosophy at AIND

docs/source/share.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Publish and share
2+

0 commit comments

Comments
 (0)