A comprehensive documentation of the SODA for SPARC project!
Client
Server
| Color | Hex |
|---|---|
| Primary Color | |
| Secondary Color | |
| Accent Color | |
| Text Color |
To run this project, you will need to add the following environment variables to your .env.local file
- None at the moment
This project uses Yarn as package manager
npm install --global yarnAdditionally, 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.
Clone the project
git clone https://github.com/fairdataihub/SODA-for-SPARC-Docs.gitGo to the project directory
cd SODA-for-SPARC-DocsInstall dependencies
yarn installStart the server
yarn startYou 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
docsdirectory) is ready to be frozen. - Update the
versionkey in package.json for this repository.
yarn run docusaurus docs:version 5.3.0This will freeze the current version of the documentation. The files under the current docs directory will be considered to be Upcoming 🚧 version.
Use this step to build a local production version of the site. Use serve to preview the local build.
yarn build
yarn serveYou 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.
Contributions are always welcome!
See contributing.md for ways to get started.
Please read the Code of Conduct
-
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_docsdirectory.
- 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
Distributed under the MIT License. See LICENSE for more information.
Contact us on Twitter: @fairdataihub
Send us an E-mail: [email protected]
Project Link: SODA-for-SPARC
A special thank you to Vercel for hosting our application documentation.
