Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fairdataihub/soda-for-sparc-docs
Documentation for the SODA for SPARC application
https://github.com/fairdataihub/soda-for-sparc-docs
curation documentation macos sparc-dataset ubuntu windows
Last synced: about 2 months ago
JSON representation
Documentation for the SODA for SPARC application
- Host: GitHub
- URL: https://github.com/fairdataihub/soda-for-sparc-docs
- Owner: fairdataihub
- License: mit
- Created: 2021-12-04T02:20:56.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-02T23:29:19.000Z (2 months ago)
- Last Synced: 2024-12-03T00:26:21.897Z (2 months ago)
- Topics: curation, documentation, macos, sparc-dataset, ubuntu, windows
- Language: MDX
- Homepage: https://docs.sodaforsparc.io/
- Size: 34.6 MB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
- Codemeta: codemeta.json
Awesome Lists containing this project
README
SODA for SPARC Documentation
A comprehensive documentation of the SODA for SPARC project!
What is SODA for SPARC?
·
Documentation
·
Changelog
·
Report Bug
·
Request Feature
# :notebook_with_decorative_cover: Table of Contents
- [About the Documentation](#star2-about-the-documentation)
- [Tech Stack](#space_invader-tech-stack)
- [Color Reference](#art-color-reference)
- [Environment Variables](#key-environment-variables)
- [Getting Started](#toolbox-getting-started)
- [Prerequisites](#bangbang-prerequisites)
- [Run Locally](#running-run-locally)
- [Versioning](#stopwatch-versioning)
- [Build locally](#building_construction-build-locally)
- [Deployment](#triangular_flag_on_post-deployment)
- [Contributing](#wave-contributing)
- [Code of Conduct](#scroll-code-of-conduct)
- [FAQ](#grey_question-faq)
- [License](#warning-license)
- [Contact](#handshake-contact)
- [Acknowledgements](#gem-acknowledgements)
## :star2: About the Documentation
### :space_invader: Tech Stack
Client
Server
### :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.](https://nodejs.org/en/download/)
### :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](https://github.com/megasanjay) or [@aaronm-2112](https://github.com/aaronm-2112) on the review page.
Only do these steps after all changes to the documentation for the specific version have been completed:
1. Update the docs changelog to be on parity with the changelog in [@SODA-for-SPARC](https://github.com/fairdataihub/SODA-for-SPARC/blob/main/CHANGELOG.md)
2. Make sure the current docs version (the `docs` directory) is ready to be frozen.
3. 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
```
### :triangular_flag_on_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`](https://github.com/fairdataihub/SODA-for-SPARC-Docs/blob/main/CONTRIBUTING.md) for ways to get started.
### :scroll: Code of Conduct
Please read the [Code of Conduct](https://github.com/fairdataihub/SODA-for-SPARC-Docs/blob/master/CODE_OF_CONDUCT.md)
## :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`](https://github.com/fairdataihub/SODA-for-SPARC-Docs/blob/main/LICENSE) for more information.
## :handshake: Contact
Contact us on Twitter: [@fairdataihub](https://twitter.com/fairdataihub)
Send us an E-mail: [email protected]
Project Link: [SODA-for-SPARC](https://github.com/fairdataihub/SODA-for-SPARC)
## :gem: Acknowledgements
A special thank you to Vercel for hosting our application documentation.
