Repository

Repository trong Guidebook Cloud là đơn vị chính để quản lý tài liệu. Mỗi repository tương ứng với một bộ tài liệu được xuất bản.

Khái niệm

  • Repository - Một dự án tài liệu được quản lý trong Guidebook Cloud
  • Slug - Định danh duy nhất cho repository, sử dụng trong URL
  • Branch - Phiên bản tài liệu, tương ứng với branch trong GitHub

Import repository

  1. Từ trang danh sách repository, nhấn Import Repository
  2. Chọn repository GitHub từ danh sách
  3. Nhập thông tin:
    • Name: Tên hiển thị của repository
    • Slug: Định danh URL (chỉ chữ cái thường, số, dấu gạch ngang)
    • Documentation Path: Đường dẫn tài liệu (tự động phát hiện từ book.json)
  4. Nhấn Import

Tự động phát hiện book.json

Khi bạn chọn repository GitHub, hệ thống sẽ tự động tìm kiếm file book.json và đặt đường dẫn tài liệu mặc định.

Ví dụ:

  • Nếu docs/book.json tồn tại → Documentation Path = docs/
  • Nếu book.json ở thư mục gốc → Documentation Path = /

Xem chi tiết tại Tích hợp GitHub.

Cấu hình repository

Default Branch

Branch mặc định sẽ được hiển thị khi truy cập URL chính của repository.

  1. Vào Settings của repository
  2. Chọn Default Branch từ danh sách branch đã build
  3. Nhấn Save Changes

Xóa repository

  1. Vào Settings của repository
  2. Cuộn xuống phần Danger Zone
  3. Nhấn Delete Repository
  4. Xác nhận để xóa

Cảnh báo: Xóa repository sẽ xóa tất cả branch và dữ liệu liên quan. Hành động này không thể hoàn tác.

Xem thêm