BKISC Blog-News-Event Page

Netlify

.com Github Pages Domain Name: https://blog.bkisc.com/
Ngoài ra còn đang deploy ở https://bkisc-blog.netlify.app

Feature

• Light/Dark Theme
• Member/Author Pages
• Blogs Pages
• Taxonomies (View items by tags)
• Projects (Link several blogs/news/events to the same projects, used when writing multi-part series)
• Support search for content (blogs, events, news)
• Email form contact, currently sending to maintainer not club email

Requirement

• Cần tải golang về máy tại đây
• Cần tải hugo extended bằng bản binary tại đây

Note: nếu như sử dụng Unix based, có thể cài đặt thông qua các package manager như apt hoặc brew và có thể cài đặt trên docker (không official)

Installation

Clone repo về máy -> Vào thư mục git -> Chạy lệnh hugo

git clone --recurse-submodules -j8 https://github.com/clbattthcmut/bkisc.com-blog-page.git
cd bkisc.com-blog-page

# Hiện content nháp (trên front matter có draft: true)
hugo server -D -w

# Không hiện content nháp
hugo server -w

Hướng dẫn đóng góp nội dung cho trang Blog

Format file

Thành viên câu lạc bộ cần thêm tên mình vào danh sách member trước khi contribute blog

• Hướng dẫn add tên mình vào danh sách member tại đây
• Hướng dẫn đóng góp blog tại đây

Ngoài ra trang web có hai mục /news và /events để đăng tin tức hoặc thông báo sự kiện sắp diễn ra, các bài đăng trong mục này sẽ để dưới tên là admin BKISC và do bạn Admin của CLB viết.

• Hướng dẫn đăng tin tức tại đây
• Hướng dẫn đăng thông báo sự kiện tại đây

Về commit message

Note: mong mọi người commit 1 lần sau mỗi hoạt động trên với message phản ánh commit đó (cái này chỉ là gợi ý thôi, mọi người cứ commit message thoải mái nha)

[<Add, Delete, Modify>] [<Blog, News, Events, Member>]: [<Tên file/thư mục liên quan>]

Ví dụ:

Add Member: hdthinh1012
Modify Blog: duti/sekai-ctf-2022-bottle-poem
Delete Events: 2022-09-05-thaidntalk

Các bước để contribute

1. Clone repo về máy local
2. Tạo một branch khác với tên của mình (ví dụ: hoangREALER sẽ tạo branch hoangREALER thông qua lệnh git branch hoangREALER) (Đối với ai đã có project trước đó rồi thì chạy lệnh git fetch rồi git merge origin/main (cái này nên làm nha, mọi người cố gắng chạy 2 lệnh này mỗi khi chuẩn bị push lên remote để xử lý conflict trên local trước) khi đang đứng trên nhánh local tên mình)
3. Checkout vào nhánh vừa tạo thông qua lệnh git checkout <tên nhánh vừa tạo>
4. Chỉnh sửa, thay đổi, và thêm thắt cho branch của mình
5. Git add và commit phần thay đổi của mình
6. Khi đã sẵn sàng thì hãy push lên nhánh của mình trên remote luôn. Tuyệt đối không push thẳng lên main nha.
7. Tạo một pull request và chờ maintainer accept.
8. Mọi người chỉ cần thấy check của bot netlify mà passed hoặc neutral all là có thể tự confirm pull request được rồi nha, mọi người có thể tự check nút 'Push without waiting ...' rồi confirm merge request luôn nha.