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
- Vào trang chi tiết repository
- 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ái | Mô tả |
| Queued | Build đang chờ trong hàng đợi |
| Pending | Build đang chuẩn bị |
| Building | Build đang chạy |
| Success | Build thành công |
| Failed | Build thất bại |
| Cancelled | Build bị hủy |
Build thủ công
- Tìm branch cần build trong danh sách
- Nhấn nút Build (biểu tượng tên lửa)
- Đợ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
- Vào Settings của repository
- Chọn branch từ dropdown Default Branch
- 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
- Tìm branch trong danh sách
- Nhấn History để xem các build trước đó
- 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:
- Branch sẽ hiển thị trong phần Deleted Branches with Build Assets
- Tài liệu vẫn có thể truy cập được
- Admin có thể xóa build assets để giải phóng dung lượng
Xóa build assets
- Tìm branch đã xóa trong danh sách
- Nhấn Delete
- 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