Cloud Temple Documentation

Welcome to the official documentation repository for Cloud Temple. Here, you’ll find guides and resources to help you better understand and utilize Cloud Temple’s services and solutions.

A PROD version of this documentation is available here. This repository and the website are synchronized to ensure up-to-date content.

A DEV version of this documentation is available here.

This project is continuously updated with new guides and improvements.

Contributing

We value your contributions! Whether it’s improving an existing guide or creating a new one, your input helps us make this repository better.

How to Contribute

1. Fork this repository: Clone your fork to your local environment.
2. Make your changes: Update or create guides.
3. Submit a Pull Request (PR): Propose your changes to the develop branch.

Our team will review your contribution, provide feedback if needed, and integrate approved changes.

Guidelines for Contributions

• Ensure your contributions are accurate, tested, and well-documented. • Include a brief explanation of your changes in the PR comments. • Follow the structure and style of existing guides for consistency.

Licensing

By contributing to this repository, you agree to the terms outlined in the LICENSE file.

Working Locally with Docker

To get started, follow these simple steps:

1. Navigate to the Docker directory:

cd docker/local

2. Launch the services with Docker Compose:

docker-compose up

3. Access the documentation locally:

Open your browser and go to: http://localhost:3000/docs/

Base url is set to "/docs" when running on non production build (locally or deployed on github pages)

🎉 Your local environment is ready!

Working Locally without Docker

Prerequisites

• Node.js (version 18.0 or higher)
• yarn package manager

Installation Steps

1. Install dependencies

   yarn install

2. Start the development server

   yarn start

   This command will start the Docusaurus development server with hot reloading enabled.

3. Access the documentation locally

   Open your browser and go to: http://localhost:3000/docs/

   Base url is set to "/docs" when running on non production build (locally or deployed on github pages)

Multi-language Development

The documentation supports 5 languages: French (default), English, Spanish, Italian, and German.

Working with Multiple Languages

1. Default Language (French)

   • All content is written in French in the /docs/ directory
   • This is the source language for all translations

2. Start with a specific language

   # Start in English
   yarn start -- --locale en
   
   # Start in Spanish
   yarn start -- --locale es
   
   # Start in Italian
   yarn start -- --locale it
   
   # Start in German
   yarn start -- --locale de

🎉 Your local environment is ready!

Build and run locally in production mode

To get started, follow these simple steps:

1. Build the docker image:

docker build -t docs:v3 . -f docker/production/Dockerfile

2. Launch the services with Docker Compose:

docker run -it --rm -p 8080:80 --name docs docs:v3

3. Access the documentation locally (all pages and all langages should work):

Open your browser and go to: http://localhost:8080

Base url is set to "/" on production build

Scripts for Automation

This project includes several scripts to automate documentation and translation tasks. For complete technical details on all scripts, please refer to the Scripts README.

📜 LLMaaS Model Documentation Generator

This Python script automatically generates the models.md page from a YAML configuration file.

• Source: memory-bank/models_config.yaml
• Output: docs/llmaas/models.md

Usage

To update the model documentation, run the following command from the project root:

yarn generate:models
# or directly:
python scripts/generate_models_doc/generate_models_doc.py

🌍 Translation System

This documentation supports multiple languages. The primary content is written in French (in the /docs/ directory) and automatically translated using an advanced Python system powered by the Cloud Temple LLMaaS API.

The system uses SHA-256 hashing to intelligently detect modified files, ensuring that only new or changed content is sent for translation. It features a modern command-line interface with real-time progress and detailed statistics.

Quick Start

1. Install Dependencies:

   cd scripts/translate_py
   pip install -r requirements.txt

2. Configure Environment: Copy the example .env file and add your API key.

   # From the scripts/translate_py directory
   cp .env.example .env
   # Now, edit the .env file with your credentials

3. Run Translation: After adding or modifying content in the /docs directory, run the translation from the project root.

   # Translate all modified files to all supported languages
   python scripts/translate_py/translate.py
   
   # Perform a dry run to see what would be translated
   python scripts/translate_py/translate.py --dry-run

For a complete list of commands, advanced features (like --force, --init, .notranslation files), and troubleshooting, please see the detailed Translation Script Documentation.