Từ Open trong Open-garden for Techies nghĩa là chào đón sự đóng góp từ những Techie khác với mục đích cung cấp/cải thiện bài viết theo định hướng phát triển của blog. Hướng dẫn này không phù hợp nếu bạn muốn xây dựng khu vườn của riêng mình (chứa những bài viết không liên quan đến định hướng của blog).
Điều kiện đóng góp ⚖️
- Tuân thủ nguyên tắc viết bài
- Có tài khoản Github
- Có kiến thức cơ bản về Obsidian Flavored Markdown
Mẹo
Nếu bạn không chắc đóng góp của mình có cần thiết hay không, hãy tạo Github Issues để thảo luận trước khi tiếp tục
Hướng dẫn cụ thể 🔬
Lưu ý
Lần đầu tạo/chỉnh sửa bài viết sẽ yêu cầu bạn đăng nhập vào hệ thống quản lý bài viết của trang web thông qua tài khoản Github
Tạo bài viết mới
- Tại trang tổng quan trạng thái các bài viết, nhấn vào nút “Quick add” để thêm mới bài viết
- Chọn thể loại bài viết bạn muốn đóng góp
- Điền các trường thông tin ở bên trái giao diện chỉnh sửa bài viết
- Title (Bắt buộc): Tiêu đề của bài viết
- Description: Mô tả ngắn gọn nội dung bài viết
- Language: Lựa chọn ngôn ngữ bài viết sử dụng
- Updated on: Chọn ngày cập nhật nội dung bài viết
- Tags: Gán các thẻ liên quan đến bài viết
- Social Description: Mô tả bài viết xuất hiện trong liên kết xem trước trên mạng xã hội (thay thế Description)
- Social Image: Ảnh bìa tùy chỉnh xuất hiện trong liên kết xem trước của bài viết
- Content (Bắt buộc): Nội dung chính của bài viết
- Xác nhận các trường thông tin bắt buộc được hoàn thiện
- Nhấn nút “Save” để lưu bài viết thành bản nháp
- Quản lý trạng thái bài viết bằng nút “Status: …” ngay trong giao diện chỉnh sửa này hoặc kéo thả tại trang Dashboard
- Khi bài viết sẵn sàng để đăng tải, chuyển sang trạng thái Ready
- Congratulations 🎉 Bài viết của bạn đang trong hàng chờ phê duyệt, theo dõi trạng thái phê duyệt trên Github Pull Request của web blog để nhận feedback điều chỉnh nếu có.
Chỉnh sửa bài viết
- Tại đầu trang bài viết bạn muốn chỉnh sửa, nhấn nút ” Edit”
- Sửa các trường thông tin ở bên trái giao diện chỉnh sửa bài viết
- Nếu không có lý do gì đặc biệt, trường
Updated onphải được cập nhật về trạng thái hiện tại bằng cách nhấn nút “Now”
- Nếu không có lý do gì đặc biệt, trường
- Đảm bảo giao diện xem trước bên phải không bị lỗi về khả năng hiển thị. Tham khảo các lỗi hiển thị đã biết để hạn chế chúng.
- Nhấn nút “Save” để lưu bài viết thành bản nháp (bản này không ảnh hưởng đến bản đã đăng tải)
- Quản lý trạng thái bài viết bằng nút “Status: …” ngay trong giao diện chỉnh sửa này hoặc kéo thả tại trang Dashboard
- Khi bài viết sẵn sàng để đăng tải, chuyển sang trạng thái Ready
- Congratulations 🎉 Bài viết của bạn đang trong hàng chờ phê duyệt, theo dõi trạng thái phê duyệt trên Github Pull Request của web blog để nhận feedback điều chỉnh nếu có.
Lưu ý
- Có thể mất một lúc để bạn thấy được các thay đổi cập nhật trên giao diện của hệ thống quản lý bài viết.
- Trên trang Github Pull Request của web blog, bạn có thể dùng thanh tìm kiếm kết hợp bộ lọc để nhanh chóng theo dõi tình trạng phê duyệt của bài mình đã viết.
- Sẽ mất khoảng 24h sau khi được phê duyệt để bài viết chính thức xuất hiện trên blog.
Nguyên tắc viết bài 📜
Để duy trì tính nhất quán và giá trị bền vững cho mọi bài viết, bạn nên đáp ứng các nguyên tắc dưới đây khi tham gia đóng góp, điều này giúp tăng khả năng bài viết được duyệt để có mặt chính thức trên blog.
Bắt buộc
- Sử dụng Heading có thứ cấp rõ ràng, không bỏ/nhảy cấp và bắt đầu từ H2 trở đi
- Sử dụng thông tin giả hoặc làm mờ thông tin nhạy cảm trước khi đưa vào bài viết
- Nội dung bài viết được thiết kế theo triết lý Evergreen
- Gán thẻ
#GenAIđối với bài viết do AI hỗ trợ - Sử dụng cú pháp Obsidian Comments hoặc HTML comments để ẩn phần nội dung không muốn thấy trong bài viết trên blog.
Khuyến khích
- Sử dụng cú pháp Obisidian Callouts để làm nổi bật thông tin
- Thêm emoji để tạo điểm nhấn thị giác nhưng không lạm dụng. Những vị trí lý tưởng để đặt emoji: sau tiêu đề H2, cuối đoạn văn, đầu danh sách.
- Hoàn thiện các trường thông tin tùy chọn trong giao diện chỉnh sửa bài viết
- Gắn thẻ trình độ bài viết để xác định đối tượng đọc phù hợp như bài viết hiện tại. Các thẻ được chấp nhận:
#Beginner#Intermediate#Advanced#Expert - Tận dụng AI với tư cách là trợ lý biên tập viên theo nguyên tắc Human-in-the-Loop
Cảnh báo
Tất cả các bài viết đóng góp đều sẽ được sàng lọc kỹ càng bởi người kiểm duyệt, nên hãy đảm bảo các nguyên tắc bắt buộc được đáp ứng đầy đủ trong điều kiện cho phép, đặc biệt là trung thực, minh bạch và có trách nhiệm với nội dung do AI hỗ trợ.
Các lỗi hiển thị đã biết 🐛
Giao diện xem trước trên hệ thống quản lý bài viết có đôi chút khác biệt với cách bài viết thực sự xuất hiện trên trang blog, nên việc phát sinh một số lỗi hiển thị là điều khó tránh khỏi. Dưới đây là tổng hợp các lỗi đã biết giúp bạn hạn chế chúng trên các bài viết của mình.
Giải pháp khắc phục triệt để lỗi hiển thị (Workaround)
Callouts bị vỡ bố cục hiển thị
(coming soon)
Câu hỏi thường gặp ❓
Các trường tùy chọn trong giao diện chỉnh sửa bài viết có ý nghĩa gì?
Chúng góp phần làm tăng khả năng hiện diện của bài viết trên Internet, đặc biệt có ích với các công cụ tìm kiếm như Google. Cụ thể:
- Description: Mô tả ngắn về nội dung bài viết (1-2 câu). Giúp hiển thị đoạn text ngay dưới tiêu đề khi bài xuất hiện trên Google.
- Language: Ngôn ngữ chính của bài viết. Giúp Google phân phối bài đến đúng đối tượng độc giả.
- Updated on: Ngày cập nhật nội dung gần nhất. Cho Google biết bài vẫn còn được duy trì, giúp cải thiện thứ hạng tìm kiếm.
- Tags: Các từ khóa liên quan đến chủ đề bài viết. Giúp bài dễ được tìm thấy hơn khi người dùng tìm kiếm những chủ đề đó.
- Social Description: Mô tả hiển thị khi bài được chia sẻ lên mạng xã hội. Có thể khác với Description để phù hợp hơn với từng nền tảng.
- Social Image: Ảnh thumbnail hiển thị khi bài được chia sẻ lên mạng xã hội. Ảnh bắt mắt giúp tăng tỉ lệ người nhấn vào đọc bài.