Branch

Mỗi branch trong GitHub repository tương ứng với một phiên bản tài liệu trong Guidebook Cloud.

Khái niệm

  • Branch - Phiên bản tài liệu, tương ứng với branch GitHub
  • Default Branch - Branch mặc định được hiển thị khi truy cập URL chính
  • Build - Quá trình xây dựng tài liệu từ source code

Xem danh sách branch

  1. Vào trang chi tiết repository
  2. Danh sách branch sẽ hiển thị với trạng thái build mới nhất

Trạng thái build

Trạng tháiMô tả
QueuedBuild đang chờ trong hàng đợi
PendingBuild đang chuẩn bị
BuildingBuild đang chạy
SuccessBuild thành công
FailedBuild thất bại
CancelledBuild bị hủy

Build thủ công

  1. Tìm branch cần build trong danh sách
  2. Nhấn nút Build (biểu tượng tên lửa)
  3. Đợi build hoàn tất

Xem tài liệu

Sau khi build thành công, nhấn View để xem tài liệu tại:

https://guidebook.dev/{org-slug}/{repo-slug}/{branch}/

Default Branch

Branch mặc định sẽ được hiển thị khi truy cập URL không có tên branch:

https://guidebook.dev/{org-slug}/{repo-slug}/

Thay đổi default branch

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

Branch Preview

Mỗi branch có URL riêng để xem trước:

https://guidebook.dev/{org-slug}/{repo-slug}/{branch-name}/

Ví dụ:

  • https://guidebook.dev/my-org/my-repo/main/ - Branch main
  • https://guidebook.dev/my-org/my-repo/develop/ - Branch develop
  • https://guidebook.dev/my-org/my-repo/feature-login/ - Branch feature

Xem lịch sử build

  1. Tìm branch trong danh sách
  2. Nhấn History để xem các build trước đó
  3. Thông tin hiển thị:
    • Trạng thái
    • Thời gian
    • Thời lượng
    • Commit message

Branch đã xóa

Khi branch bị xóa khỏi GitHub nhưng vẫn còn build assets:

  1. Branch sẽ hiển thị trong phần Deleted Branches with Build Assets
  2. Tài liệu vẫn có thể truy cập được
  3. Admin có thể xóa build assets để giải phóng dung lượng

Xóa build assets

  1. Tìm branch đã xóa trong danh sách
  2. Nhấn Delete
  3. Xác nhận để xóa

Cảnh báo: Xóa build assets sẽ xóa vĩnh viễn nội dung tài liệu của branch đó.

Xem thêm