Skip to content

Commit

Permalink
docs: Improved license guide, fixed broken URLs
Browse files Browse the repository at this point in the history
  • Loading branch information
caniko committed Jul 24, 2024
1 parent d916a1d commit b52d816
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/dataset/2-upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ We recommend you to follow the guide in the exact sequence provided. This ensure
You must accept the terms and conditions before uploading data. The terms include:
- Statement that the data is not false or misleading
- Redistribution rights
- Data licensing agreement with the license of your choice, see [guide to pick license](../guides/choose_dataset_license.md)
- Data licensing agreement with the license of your choice, see [guide to pick license](../guides/choose_dataset_license.md); the default license is [ODC-BY](../guides/choose_dataset_license.md#open-data-commons-odc-licenses "Allows use with proper credit to the original creator, ensuring acknowledgment while enabling broad use.").

#### Data standardization
Your imaging metrics must be in dataframe or tabular data format like Excel, CSV, or (even better) parquet. The column names must be in the SynDB standardized format. You can find supported column names for each SynDB table in the [schema overview]({{ source.dataset.schema_list_url }} "Link to GitHub where the overview is versioned").
Expand Down
2 changes: 1 addition & 1 deletion docs/get_started/0-home.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

SynDB is the platform for finding, and sharing synapse metrics derived from high resolution microscopy assays.

Head over to the [installation guide](2-install.md) to get started; [upload guide](../dataset/2-upload.md) to share your data; [search guide](../dataset/1-search.md) to find data; [API documentation](https://api.syndb.org/docs) for advanced users.
Head over to the [installation guide](2-install.md) to get started; [upload guide](../dataset/2-upload.md) to share your data; [search guide](../dataset/1-search.md) to find data; [API documentation]({{ api.url }}) for advanced users.

## :simple-youtube:{ .youtube } Tutorials on YouTube
Explore the tutorials on how to use SynDB on our [YouTube playlist]({{ youtube.playlist }}).
Expand Down
1 change: 0 additions & 1 deletion docs/get_started/1-why_syndb.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

In SynDB, there are two perspectives the image data owner and the data scientist. You may skip to these sections if you only care about those perspectives. Feel free to read the entire article.


## Image data owner
- **Data sharing**: Others can use your data to teach, increasing the educational value of the data.
- **Citations**: Whenever your data is used in a publication, you will be cited, increasing your visibility in the scientific community.
Expand Down
2 changes: 1 addition & 1 deletion docs/get_started/3-quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ The GUI will open in your default web browser, and in case the browser is alread
## Next steps
- [Search data](../dataset/1-search.md)
- [Upload data](../dataset/2-upload.md)
- [API documentation](https://api.syndb.org/docs)
- [API documentation]({{ api.url }})
28 changes: 16 additions & 12 deletions docs/guides/choose_dataset_license.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,25 @@ When sharing microscopy data derived datasets, selecting an appropriate license
- **Commercial Use**: Reflect on whether you want to permit commercial use of your data. Your institution may have specific policies regarding commercial use.

## Licenses

The following are some common licenses used for sharing data on the web, which we also use on the SynDB platform.

!!! tip "Use ODC over CC"
**We recommend the ODC licenses for datasets on SynDB.** You are free to use Creative Commons licenses as well, just note that they are not designed for data. The default license for SynDB is ODC-BY.

### Open Data Commons (ODC) Licenses
Open Data Commons (ODC) licenses are specifically tailored for datasets and databases, focusing on maximizing accessibility and proper attribution in data sharing.

#### PDDL (Public Domain Dedication and License)
Places the dataset in the public domain, allowing unrestricted use and maximizing openness and usability.

#### ODC-BY (Attribution License)
Allows use with proper credit to the original creator, ensuring acknowledgment while enabling broad use.

#### ODC-ODbL (Open Database License)
Permits sharing, modifying, and using the dataset with attribution and requires derivative databases to be shared under the same license, promoting open access and collaborative improvement while keeping derivative databases equally accessible.

### Creative Commons (CC) Licenses
Creative Commons (CC) licenses are versatile and well-suited for a wide range of creative works, including datasets

#### CC0 (Public Domain Dedication)
Allows the use of the dataset without any restrictions, making it ideal for maximizing usability and dissemination.
Expand All @@ -30,17 +45,6 @@ Allows use for non-commercial purposes with proper credit, restricting use to no
#### CC BY-NC-SA (Attribution-NonCommercial-ShareAlike)
Permits non-commercial use with appropriate credit and sharing of derivative works under the same license, ensuring non-commercial use and open sharing under the same terms.

### Open Data Commons (ODC) Licenses

#### PDDL (Public Domain Dedication and License)
Places the dataset in the public domain, allowing unrestricted use and maximizing openness and usability.

#### ODC-BY (Attribution License)
Allows use with proper credit to the original creator, ensuring acknowledgment while enabling broad use.

#### ODC-ODbL (Open Database License)
Permits sharing, modifying, and using the dataset with attribution and requires derivative databases to be shared under the same license, promoting open access and collaborative improvement while keeping derivative databases equally accessible.

## Conclusion

Selecting the right license for your microscopy data derived dataset is essential for controlling how your data is used and ensuring it meets your sharing objectives. By considering the options and your specific needs, you can choose a license that balances openness, credit, and control, fostering collaboration and advancement in your field.
2 changes: 1 addition & 1 deletion includes/macros.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
api:
url: https://api.syndb.xyz
openapi: https://nrp-api.syndb.xyz/openapi.json
openapi: https://api.syndb.xyz/openapi.json

source:
dataset:
Expand Down

0 comments on commit b52d816

Please sign in to comment.