Conventions - MLOpsVN/courses.mlops.vn GitHub Wiki
- Xem tại Translation Conventions
- Luôn sử dụng relative path thay vì absolute path khi có thể. Ví dụ:
../../../assets/images/abc.jpg
- Chữ in nghiêng: khái niệm mới
-
Inline: cho các đường dẫn ví dụ
data-pipeline/deployment/Dockerfile
- Đầu mỗi bài nên có một bức ảnh thể hiện chủ đề của bài viết
- Ảnh có bản quyền của MLOps VN cần được chứa logo của MLOps VN
- Luôn sử dụng attribute
loading="lazy"
trong thẻ<img/>
- Kích thước của ảnh nên là ~100KB
- Ảnh không cần chú thích nguồn có thể được lấy từ https://unsplash.com/. Khi download nên chọn
Size=Small
để giảm kích thước của ảnh - Ảnh cần chú thích nguồn phải đặt trong thẻ
<figure></figure>
, caption sẽ đặt trong thẻ<figcaption>Chú thích</figcaption>
. Ví dụ:# Ảnh không cần chú thích <img src="../../../assets/images/mlops-crash-course/speedy.jpg" loading="lazy"/> # Ảnh cần chú thích <figure> <img src="../../../assets/images/mlops-crash-course/mlops-loop-en.jpg" loading="lazy"/> <figcaption>Source: ml-ops.org</figcaption> </figure>
- Custom CSS nên được đặt tại
docs/assets/stylesheets/styles.css
- Nếu muốn tạo thêm file CSS, cần đặt trong
docs/assets/stylesheets
. Sau khi tạo cần chỉ rõ đường dẫn tới file CSS đó trong filemkdocs.yml
. Ví dụ:extra_css: [assets/stylesheets/styles.css]
- Gồm 4 phần chính (sử dụng ## để đánh dấu từng phần):
-
Giới thiệu:
- Tóm tắt về nội dung bài học trước (nếu có)
- Tóm tắt về nội dung bài học này
- Định nghĩa về nội dung chính sẽ học
- Tại sao nội dung này quan trọng? Ứng dụng của nó là gì? Được thực hiện trong những trường hợp nào?
- Sẽ làm được gì sau khi học xong
-
Môi trường phát triển (chủ yếu xuất hiện ở các bài có nội dung thực hành)
- Liệt kê các service trong platform liên quan tới bài học để user start
- Liệt kê các tools sẽ được dùng? Để làm công việc gì?
- Nội dung chính:
-
Tổng kết:
- Tóm tắt về những gì đã học
- Các hạn chế
- Hướng phát triển thêm
- Nội dung bài tiếp theo
- Tài liệu tham khảo:
-
Giới thiệu:
- Code sẽ được trình bày đi kèm với line number và annotation để giải thích từng dòng code như sau:
```py linenums="1" title="bubble_sort.py"
print("Something") # (1)
```
1. Look ma, less line noise!
- Sử dụng expanded block với các loại note như ở đây: https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types