https://github.com/crane-cloud/documentation
A repository for all crane cloud documentation
https://github.com/crane-cloud/documentation
Last synced: about 2 months ago
JSON representation
A repository for all crane cloud documentation
- Host: GitHub
- URL: https://github.com/crane-cloud/documentation
- Owner: crane-cloud
- Created: 2020-06-12T06:54:08.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-12-01T09:17:49.000Z (7 months ago)
- Last Synced: 2025-12-03T19:52:22.668Z (7 months ago)
- Language: CSS
- Size: 20 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Crane Cloud Documentation
> A centralised location for all information regarding usage of the platform.
## How to setup the project:
#### Clone the repository
` git clone https://github.com/crane-cloud/documentation.git`
* If `develop` is not up to date, `git checkout develop` for it is the default base branch for this project.
#### Install pip or upgrade its version by running
python3 -m pip install --upgrade pip
#### Install and creating a virtual environment run
python3 -m pip install virtualenv
#### To create a virtual environment run
python3 -m virtualenv name-of-your-virtual-environment
**NOTE** Remember to add the virtual environment to your gitignore.
#### To activate the virtual evnvironment created run
source env/bin/activate
#### To install the packages in the requirements.txt file run
pip install -r requirements.txt
#### To access the mkdocs yml file
cd cranecloud
#### To run the docs, run:
mkdocs serve
## Deployment
* The Deployed staging app is [here.](https://staging-docs.cranecloud.io/)
* The Deployed production app is [here.](https://docs.cranecloud.io/)