chore: update README.md and deploy.yml
Some checks failed
Deploy triz-docs to 150 / build-and-deploy (push) Has been cancelled
Some checks failed
Deploy triz-docs to 150 / build-and-deploy (push) Has been cancelled
This commit is contained in:
parent
1a461e1847
commit
23ca95bc4c
@ -1,4 +1,4 @@
|
|||||||
name: Deploy triz-docs to civital server
|
name: Deploy triz-docs to 150
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
@ -6,7 +6,7 @@ on:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build-and-deploy:
|
build-and-deploy:
|
||||||
runs-on: serveurtest150
|
runs-on: 150
|
||||||
|
|
||||||
env:
|
env:
|
||||||
GIT_REPO_URL: 145.239.66.197:3000/TrizTech/triz-docs.git
|
GIT_REPO_URL: 145.239.66.197:3000/TrizTech/triz-docs.git
|
||||||
|
|||||||
78
README.md
78
README.md
@ -1,41 +1,61 @@
|
|||||||
# Website
|
# TrizTech Engineering Documentation
|
||||||
|
|
||||||
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
|
Welcome to the official TrizTech internal engineering documentation. This site is the single source of truth for our onboarding processes, development workflows, and technical standards.
|
||||||
|
|
||||||
## Installation
|
## 🚀 Purpose
|
||||||
|
|
||||||
|
This repository hosts a high-performance, modern documentation portal built with Docusaurus. It is designed to empower our engineering team with:
|
||||||
|
- **Instant Onboarding**: Clear guides for setting up development environments.
|
||||||
|
- **Standardized Workflows**: Step-by-step instructions for our Git and task management processes.
|
||||||
|
- **Operational Excellence**: Critical guides for database management and emergency recovery.
|
||||||
|
- **Universal Search**: Fast, context-aware search across all technical resources.
|
||||||
|
|
||||||
|
## 🛠 Tech Stack
|
||||||
|
|
||||||
|
- **Engine**: [Docusaurus 3](https://docusaurus.io/) (Static Site Generator)
|
||||||
|
- **Framework**: [React](https://reactjs.org/)
|
||||||
|
- **Theme**: Custom "Dark-First" Premium Theme (TrizTech Branding)
|
||||||
|
- **Syntax Highlighting**: Prism.js (Java, SQL, Bash, XML, Properties)
|
||||||
|
- **Icons**: Emoji-based category indexing
|
||||||
|
|
||||||
|
## 📂 Documentation Structure
|
||||||
|
|
||||||
|
The documentation is organized into four core pillars:
|
||||||
|
|
||||||
|
1. **🚀 Getting Started**: Environment setup guides for TrizStock and related projects.
|
||||||
|
2. **🔄 Workflow & Processes**: Standard operating procedures for task management and branching.
|
||||||
|
3. **🐙 Git Operations**: Tool-specific guides for Git (Apache NetBeans, JetBrains IDEs, and Command-Line).
|
||||||
|
4. **🗄️ Database Operations**: SQL Server management, backup/restore protocols, and emergency data recovery.
|
||||||
|
|
||||||
|
## 💻 Local Development
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
- [Node.js](https://nodejs.org/) (LTS recommended)
|
||||||
|
- [npm](https://www.npmjs.com/)
|
||||||
|
|
||||||
|
### Installation
|
||||||
```bash
|
```bash
|
||||||
yarn
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
## Local Development
|
### Run Locally
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn start
|
npm run start
|
||||||
|
```
|
||||||
|
The site will be available at [http://localhost:3000](http://localhost:3000).
|
||||||
|
|
||||||
|
### Build for Production
|
||||||
|
```bash
|
||||||
|
npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
|
## 🎨 Design System
|
||||||
|
|
||||||
## Build
|
The site uses a custom-built design system defined in `src/css/custom.css`, featuring:
|
||||||
|
- **Glassmorphic UI**: Saturated blur effects on navigation and headers.
|
||||||
|
- **Indigo Palette**: A curated color system for both light and dark modes.
|
||||||
|
- **Premium Content Styling**: Centered images with rounded corners, shadows, and interactive hover states.
|
||||||
|
|
||||||
```bash
|
---
|
||||||
yarn build
|
|
||||||
```
|
|
||||||
|
|
||||||
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
© 2026 TrizTech Engineering. All rights reserved.
|
||||||
|
|
||||||
## Deployment
|
|
||||||
|
|
||||||
Using SSH:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
USE_SSH=true yarn deploy
|
|
||||||
```
|
|
||||||
|
|
||||||
Not using SSH:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
GIT_USER=<Your GitHub username> yarn deploy
|
|
||||||
```
|
|
||||||
|
|
||||||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user