soda-for-sparc-docs

Documentation for the SODA for SPARC application

https://github.com/fairdataihub/soda-for-sparc-docs

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 3 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (9.7%) to scientific vocabulary

Keywords

curation documentation macos sparc-dataset ubuntu windows

Last synced: 4 months ago · JSON representation ·

Repository

Documentation for the SODA for SPARC application

Basic Info

Host: GitHub
Owner: fairdataihub
License: mit
Language: MDX
Default Branch: main
Homepage: https://docs.sodaforsparc.io/
Size: 40.7 MB

Statistics

Stars: 6
Watchers: 2
Forks: 4
Open Issues: 11
Releases: 0

Topics

curation documentation macos sparc-dataset ubuntu windows

Created about 4 years ago · Last pushed 4 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Codeowners Codemeta Zenodo

SODA for SPARC Documentation

A comprehensive documentation of the SODA for SPARC project!

What is SODA? · Documentation · Changelog · Report Bug · Request Feature

:notebookwithdecorative_cover: Table of Contents

:notebookwithdecorative_cover: Table of Contents

:star2: About the Documentation

:space_invader: Tech Stack

Client

Server

Docusaurus

:art: Color Reference

| Color | Hex | | --------------- | ---------------------------------------------------------------- | | Primary Color | #13716D | | Secondary Color | #BA0D49 | | Accent Color | #6B7280 | | Text Color | #1C1E21 |

:key: Environment Variables

To run this project, you will need to add the following environment variables to your .env.local file

None at the moment

:toolbox: Getting Started

:bangbang: Prerequisites

This project uses Yarn as package manager

bash npm install --global yarn

Additionally, a version of Node.js that is >= 14 is required for compatibility with Docusarus. If your Node.js version is < 14 you can download the latest Node.js version from the Node.js download page.

:running: Run Locally

Clone the project

bash git clone https://github.com/fairdataihub/SODA-for-SPARC-Docs.git

Go to the project directory

bash cd SODA-for-SPARC-Docs

Install dependencies

bash yarn install

Start the server

bash yarn start

:stopwatch: Versioning

You can use the version script to create a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

Ideally, you should create a new branch and update the relevant pages. Then send a PR with @megasanjay or @aaronm-2112 on the review page.

Only do these steps after all changes to the documentation for the specific version have been completed:

Update the docs changelog to be on parity with the changelog in @SODA-for-SPARC
Make sure the current docs version (the docs directory) is ready to be frozen.
Update the version key in package.json for this repository.

bash yarn run docusaurus docs:version 5.3.0

This will freeze the current version of the documentation. The files under the current docs directory will be considered to be Upcoming 🚧 version.

:building_construction: Build locally

Use this step to build a local production version of the site. Use serve to preview the local build.

bash yarn build yarn serve

:triangularflagon_post: Deployment

You will not need to do anything to the hosted site. Continuous Delivery has been setup with Vercel. All you need to do is push your commit and wait for it to deploy.

:wave: Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

:scroll: Code of Conduct

Please read the Code of Conduct

:grey_question: FAQ

Can I make changes to previous versions of the documentation?
- Yes, you can make changes to previous versions of the documentation. You can do this by creating a new branch and adding your changes directly in the versioned_docs directory.

:warning: License

Distributed under the MIT License. See LICENSE for more information.

:handshake: Contact

Send us an E-mail: info@fairdataihub.org

Project Link: SODA-for-SPARC

:gem: Acknowledgements

A special thank you to Vercel for hosting our application documentation.

Owner

Name: FAIR Data Innovations Hub
Login: fairdataihub
Kind: organization
Email: info@fairdataihub.org
Location: United States of America

Website: https://fairdataihub.org
Repositories: 40
Profile: https://github.com/fairdataihub

We build open source tools to help researchers learn about and implement FAIR Data practices

Citation (CITATION.cff)

abstract: Documentation for the SODA for SPARC application
authors:
  - affiliation: FAIR Data Innovations Hub
    email: ssoundarajan@calmi2.org
    family-names: Soundarajan
    given-names: Sanjay
  - affiliation: FAIR Data Innovations Hub
    email: cmarroquin@calmi2.org
    family-names: Marroquin
    given-names: Aaron
  - affiliation: FAIR Data Innovations Hub
    email: tngo@calmi2.org
    family-names: Ngo
    given-names: Tram
  - affiliation: FAIR Data Innovations Hub
    email: dportiollo@calmi2.org
    family-names: Portillo
    given-names: Dorian
  - affiliation: FAIR Data Innovations Hub
    email: bpatel@calmi2.org
    family-names: Patel
    given-names: Bhavesh
  - affiliation: FAIR Data Innovations Hub
    email: jclark@calmi2.org
    family-names: Clark
    given-names: Jacob
cff-version: 1.2.0
date-released: '2025-09-04'
identifiers:
  - description: DOI for this software's record on Zenodo
    type: doi
keywords:
  - SPARC
  - FAIR
  - data
  - curation
  - documentation
  - macos
  - sparc-dataset
  - ubuntu
  - windows
license: MIT
message: If you use this software, please cite it as below.
repository-artifact: https://github.com/fairdataihub/SODA-for-SPARC-Docs
repository-code: https://github.com/fairdataihub/SODA-for-SPARC-Docs
title: SODA for SPARC docs
type: software
url: https://fairdataihub.org/
version: 27.11.0

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "license": "https://spdx.org/licenses/MIT",
  "codeRepository": "https://github.com/fairdataihub/SODA-for-SPARC-Docs",
  "dateCreated": "2022-04-01",
  "dateModified": "2025-10-20",
  "downloadUrl": "https://github.com/fairdataihub/SODA-for-SPARC-Docs",
  "issueTracker": "https://github.com/fairdataihub/SODA-for-SPARC-Docs/issues",
  "name": "SODA for SPARC docs",
  "version": "27.22.0",
  "description": "Documentation for the SODA for SPARC application",
  "applicationCategory": "Scientific",
  "funding": "OT2OD030213",
  "developmentStatus": "active",
  "isPartOf": "https://fairdataihub.org/",
  "referencePublication": "https://doi.org/10.1096/fasebj.2020.34.s1.02483",
  "funder": {
    "@type": "Organization",
    "@name": "National Institutes of Health (NIH)"
  },
  "keywords": [
    "SPARC",
    "FAIR",
    "data",
    "curation",
    "documentation",
    "macos",
    "sparc-dataset",
    "ubuntu",
    "windows"
  ],
  "programmingLanguage": [
    "JavaScript",
    "CSS"
  ],
  "relatedLink": [
    "https://docs.sodaforsparc.io/",
    "https://github.com/fairdataihub/SODA-for-SPARC"
  ],
  "author": [
    {
      "@type": "Person",
      "givenName": "Sanjay",
      "familyName": "Soundarajan",
      "email": "ssoundarajan@calmi2.org",
      "affiliation": {
        "@type": "Organization",
        "name": "FAIR Data Innovations Hub"
      }
    },
    {
      "@type": "Person",
      "givenName": "Aaron",
      "familyName": "Marroquin",
      "email": "cmarroquin@calmi2.org",
      "affiliation": {
        "@type": "Organization",
        "name": "FAIR Data Innovations Hub"
      }
    },
    {
      "@type": "Person",
      "givenName": "Tram",
      "familyName": "Ngo",
      "email": "tngo@calmi2.org",
      "affiliation": {
        "@type": "Organization",
        "name": "FAIR Data Innovations Hub"
      }
    },
    {
      "@type": "Person",
      "givenName": "Dorian",
      "familyName": "Portillo",
      "email": "dportiollo@calmi2.org",
      "affiliation": {
        "@type": "Organization",
        "name": "FAIR Data Innovations Hub"
      }
    },
    {
      "@type": "Person",
      "givenName": "Bhavesh",
      "familyName": "Patel",
      "email": "bpatel@calmi2.org",
      "affiliation": {
        "@type": "Organization",
        "name": "FAIR Data Innovations Hub"
      }
    },
    {
      "@type": "Person",
      "givenName": "Jacob",
      "familyName": "Clark",
      "email": "jclark@calmi2.org",
      "affiliation": {
        "@type": "Organization",
        "name": "FAIR Data Innovations Hub"
      }
    }
  ]
}

GitHub Events

Total

Create event: 31
Release event: 7
Issues event: 1
Delete event: 24
Issue comment event: 178
Push event: 165
Pull request review comment event: 24
Pull request review event: 27
Pull request event: 59

Last Year

Create event: 31
Release event: 7
Issues event: 1
Delete event: 24
Issue comment event: 178
Push event: 165
Pull request review comment event: 24
Pull request review event: 27
Pull request event: 59

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 3
Total pull requests: 359
Average time to close issues: 2 months
Average time to close pull requests: 11 days
Total issue authors: 3
Total pull request authors: 9
Average comments per issue: 1.0
Average comments per pull request: 2.37
Merged pull requests: 285
Bot issues: 3
Bot pull requests: 292

Past Year

Issues: 1
Pull requests: 37
Average time to close issues: 2 months
Average time to close pull requests: 16 days
Issue authors: 1
Pull request authors: 3
Average comments per issue: 1.0
Average comments per pull request: 2.16
Merged pull requests: 10
Bot issues: 1
Bot pull requests: 18

View more stats

Top Authors

Issue Authors

codefair-io[bot] (1)
codefair-app[bot] (1)
renovate[bot] (1)

Pull Request Authors

renovate[bot] (292)
aaronm-2112 (29)
JacobiClark (11)
megasanjay (8)
ZaidAG (6)
slugb0t (6)
tramngo1603 (4)
bvhpatel (2)
fairdataihub-bot (1)

Top Labels

Issue Labels

no-issue-activity (2) documentation (1) help wanted (1) type: dependencies (1)

Pull Request Labels

type: dependencies (246) released (166) no-pr-activity (12)

Dependencies

.github/workflows/check-misspellings.yml actions

actions/checkout v3 composite
peter-evans/create-pull-request main composite
sobolevn/misspell-fixer-action master composite

.github/workflows/codeql-analysis.yml actions

actions/checkout v3 composite
github/codeql-action/analyze v2 composite
github/codeql-action/autobuild v2 composite
github/codeql-action/init v2 composite

.github/workflows/conventional-commits.yml actions

actions/checkout v3 composite
webiny/action-conventional-commits v1.1.0 composite

.github/workflows/gitlab-sync.yml actions

actions/checkout v3 composite
wangchucheng/git-repo-sync v0.1.0 composite

.github/workflows/lint-check.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
wearerequired/lint-action v2 composite

.github/workflows/release-on-zenodo.yml actions

actions/setup-node v3 composite
megasanjay/upload-to-zenodo v2.0.1 composite

.github/workflows/semantic-release.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/stale.yml actions

actions/stale v7 composite

package.json npm

@babel/eslint-parser 7.19.1 development
@commitlint/cli 17.4.2 development
@commitlint/config-conventional 17.4.2 development
@fairdataihub/config 2.2.1 development
@semantic-release/changelog 6.0.2 development
@semantic-release/commit-analyzer 9.0.2 development
@semantic-release/git 10.0.1 development
@semantic-release/github 8.0.7 development
@semantic-release/npm 9.0.1 development
@semantic-release/release-notes-generator 10.0.3 development
autoprefixer 10.4.11 development
babel-eslint 10.1.0 development
devmoji 2.3.0 development
eslint 8.31.0 development
eslint-config-airbnb 19.0.4 development
eslint-config-prettier 8.6.0 development
eslint-plugin-import 2.27.4 development
eslint-plugin-jsx-a11y 6.7.1 development
eslint-plugin-react 7.32.0 development
husky 8.0.3 development
lint-staged 13.1.0 development
postcss 8.4.21 development
prettier 2.8.2 development
prettier-plugin-tailwindcss 0.2.1 development
pretty-quick 3.1.3 development
semantic-release 20.0.2 development
tailwindcss 3.1.8 development
@docusaurus/core 2.2.0
@docusaurus/preset-classic 2.2.0
@emotion/react 11.10.5
@emotion/styled 11.10.5
@iconify/react 4.0.1
@mdx-js/react 1.6.22
@mui/material 5.11.1
@notionhq/client 2.2.3
@svgr/webpack 6.5.1
axios 1.2.2
clsx 1.2.1
docusaurus-plugin-umami ^2.0.0
docusaurus-theme-frontmatter ^1.3.0
express 4.18.2
file-loader 6.2.0
prism-react-renderer 1.3.5
prop-types 15.8.1
react 18.2.0
react-cookie 4.1.1
react-dom 18.2.0
react-lottie 1.2.3
react-player 2.11.0
url-loader 4.1.1
uuid 9.0.0

yarn.lock npm

1859 dependencies

versions.json meteor