FAQ

Câu hỏi thường gặp về Guidebook Cloud.

Tổng quan

Guidebook Cloud là gì?

Guidebook Cloud là dịch vụ hosting tài liệu nội bộ, tương thích với định dạng GitBook/HonKit. Nó cho phép bạn tự động xuất bản tài liệu từ repository GitHub.

Guidebook Cloud khác gì với GitBook?

  • Guidebook Cloud tập trung vào tài liệu nội bộ với kiểm soát truy cập mạnh mẽ
  • Tích hợp trực tiếp với GitHub thông qua GitHub App
  • Hỗ trợ IP allowlist để giới hạn truy cập

Định dạng tài liệu nào được hỗ trợ?

Guidebook Cloud hỗ trợ định dạng GitBook/HonKit:

  • Markdown files
  • File SUMMARY.md làm mục lục
  • Ảnh và tài nguyên tĩnh

Repository

Làm sao để tạo repository mới?

  1. Nhấn New repository từ trang chính
  2. Nhập tên và slug
  3. Kết nối với GitHub repository
  4. Cấu hình đường dẫn tài liệu

Tại sao build thất bại?

Kiểm tra:

  1. File SUMMARY.md có tồn tại tại đường dẫn đã cấu hình
  2. Các liên kết trong SUMMARY.md trỏ đến file tồn tại
  3. Không có lỗi cú pháp trong Markdown

Làm sao để thay đổi default branch?

  1. Vào Settings của repository
  2. Chọn branch từ dropdown Default Branch
  3. Nhấn Save Changes

GitHub

Làm sao để cài đặt GitHub App?

  1. Vào Settings > GitHub Integration
  2. Nhấn Install GitHub App
  3. Chọn tài khoản và repository
  4. Nhấn Install

Tại sao auto deploy không hoạt động?

Kiểm tra:

  1. GitHub App đã được cài đặt
  2. Repository đã được kết nối
  3. Auto Deploy đã bật
  4. Branch nằm trong danh sách branch deploy

Làm sao để kết nối repository từ tổ chức GitHub khác?

  1. Cài đặt GitHub App cho tổ chức đó trước
  2. Sau đó bạn có thể chọn repository từ tổ chức đó khi kết nối

Truy cập

Làm sao để giới hạn truy cập theo IP?

  1. Vào Access Rules
  2. Nhấn Add Rule
  3. Nhập địa chỉ IP hoặc CIDR
  4. Nhấn Add Rule

Tại sao tôi bị chặn truy cập?

  • IP của bạn không nằm trong danh sách cho phép
  • Liên hệ admin để thêm IP của bạn

Làm sao để biết IP hiện tại của tôi?

Truy cập whatismyip.com hoặc chạy lệnh curl ifconfig.me

Thành viên

Làm sao để mời thành viên mới?

  1. Vào Team Members
  2. Nhấn Invite Members
  3. Nhập email và chọn vai trò
  4. Gửi lời mời

Sự khác biệt giữa các vai trò là gì?

  • Owner: Quyền cao nhất, xóa tổ chức, xóa thành viên
  • Admin: Quản lý repository, cài đặt, mời thành viên, quản lý team
  • Member: Chỉ có thể xem repository và team được chỉ định qua team membership

Xem chi tiết tại Vai trò và quyền hạn.

Làm sao để thay đổi vai trò thành viên?

Chỉ Owner mới có thể thay đổi:

  1. Vào Team Members
  2. Nhấn Edit trên thành viên cần sửa
  3. Chọn vai trò mới
  4. Nhấn Save Changes

Team

Team dùng để làm gì?

Team giúp tổ chức thành viên và repository thành các nhóm logic, dễ dàng quản lý.

Làm sao để tạo team?

  1. Vào Teams
  2. Nhấn New Team
  3. Nhập tên và mô tả
  4. Nhấn Create Team

Khác

Guidebook Cloud có miễn phí không?

Guidebook Cloud cung cấp các gói dịch vụ khác nhau. Liên hệ để biết chi tiết giá.

Dữ liệu của tôi được lưu trữ ở đâu?

Dữ liệu được lưu trữ trên Cloudflare infrastructure, đảm bảo hiệu suất và bảo mật cao.