Cách đóng góp
Kho là một repo GitHub. Mỗi lần ai đó lưu, site tự build lại sau khoảng 1–2 phút.
Cần có: tài khoản GitHub và được mời vào repo Fine-chemical-All-in-one-Data với quyền Write. Chưa có thì nhờ BA mời.
Cách 1 — Sửa một trang ngay trên trình duyệt (khuyên dùng)
Phần tiêu đề “Cách 1 — Sửa một trang ngay trên trình duyệt (khuyên dùng)”- Mở trang cần sửa, kéo xuống cuối, bấm Sửa trang.
- GitHub mở trình soạn với file
.mdcủa trang. Sửa nội dung. - Bấm Commit changes…, viết một dòng mô tả (xem mẫu commit), chọn Commit directly to the
mainbranch, bấm Commit changes. - Đợi 1–2 phút rồi tải lại trang.
Muốn người khác xem trước khi lên site thì ở bước 3 chọn Create a new branch … and start a pull request thay vì commit thẳng.
Cách 2 — Thêm trang mới
Phần tiêu đề “Cách 2 — Thêm trang mới”- Trên GitHub, vào thư mục
src/content/docs/<module>/(ví dụmes). - Bấm Add file → Create new file, đặt tên
<slug>.md— chữ thường, gạch nối, trùng slug của flow site nếu chức năng đã có flow (ví dụdefect-records.md). - Chép khung từ mẫu trang, điền, commit.
- Tạo bản tiếng Anh cùng tên ở
src/content/docs/en/<module>/.
Cách 3 — Sửa nhiều file, thêm ảnh (trên máy)
Phần tiêu đề “Cách 3 — Sửa nhiều file, thêm ảnh (trên máy)”git clone https://github.com/NhatPD2000/Fine-chemical-All-in-one-Data.gitcd Fine-chemical-All-in-one-Datanpm installnpm run dev # xem thử ở http://localhost:4321# ... sửa file ...npm run check # bộ kiểm: thiếu bản EN, EN cũ hơn VI, trùng mã BR, thiếu frontmattergit pull --ff-onlygit add <file đã sửa>git commit -m "test(mes/repair-rework): thêm ca biên Qty 1"git pushẢnh: đặt trong thư mục img/ cạnh trang, đặt tên <slug>-<mô-tả>.png, chèn bằng . Ảnh nên dưới 500 KB.
Song ngữ
Phần tiêu đề “Song ngữ”Mỗi trang có bản tiếng Việt (src/content/docs/…) và bản tiếng Anh (src/content/docs/en/…, cùng đường dẫn).
- Sửa bản nào thì cố gắng sửa luôn bản kia trong cùng commit.
- Không tự dịch được thì vẫn commit bản của mình. Bộ kiểm sẽ liệt kê trang có bản EN cũ hơn bản VI để người khác dịch tiếp.
- Trang chưa có bản EN thì site EN tự hiện bản VI kèm ghi chú.
Mẫu mô tả commit
Phần tiêu đề “Mẫu mô tả commit”<loại>(<module>/<slug>): <nội dung>| Loại | Dùng khi |
|---|---|
rule |
Đổi business rule, trạng thái, field, thông báo (mục 3–6) |
dev |
Thêm/sửa ghi chú Dev (mục 7) |
test |
Thêm/sửa ghi chú Test (mục 8) |
oq |
Thêm câu hỏi mở hoặc chốt câu hỏi (mục 9–10) |
docs |
Trang chung, sửa chữ, thêm trang |
i18n |
Dịch / đồng bộ bản EN |
Ví dụ: rule(mes/repair-rework): BR-RW-13 cho phép Re-plan khi Scrap = 0 (Q-20261020-02).
Không đưa lên kho
Phần tiêu đề “Không đưa lên kho”- Mật khẩu, token, tài khoản đăng nhập hệ thống.
- File gốc khách gửi (
.pptx,.xlsx,.docx) — chỉ ghi tên file và nơi lưu. - Dữ liệu cá nhân của nhân viên khách hàng.