FAIRshare Documentation

A comprehensive documentation of the FAIRshare project!

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

:notebookwithdecorative_cover: Table of Contents

• About the Documentation
  • Tech Stack
  • Color Reference
  • Environment Variables
• Getting Started
  • Prerequisites
  • Run Locally
  • Versioning
  • Build locally
  • Deployment
• Contributing
  • Code of Conduct
• FAQ
• License
• Contact
• Acknowledgements

:star2: About the Documentation

:space_invader: Tech Stack

:art: Color Reference

| Color | Hex | | --------------- | ---------------------------------------------------------------- | | Primary Color | #1E40AF | | Secondary Color | #F97316 | | 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

:running: Run Locally

Clone the project

bash git clone https://github.com/fairdataihub/FAIRshare-Docs.git

Go to the project directory

bash cd FAIRshare-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 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 @FAIRshare
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

: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

Contact us on Twitter: @fairdataihub

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

Project Link: FAIRshare

:gem: Acknowledgements

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