seagl.github.io

ซีจีแอล

นี่คือซอร์สโค้ดสำหรับเว็บไซต์ที่ให้บริการที่ https://seagl.org

ใช้ Jekyll เป็นตัวสร้างไซต์แบบคงที่ด้วย GitHub Pages

ไซต์จะแสดงผลโดยอัตโนมัติทุกครั้งที่มีการพุชโค้ดไปยังพื้นที่เก็บข้อมูลที่ใช้ร่วมกันที่ GitHub

โดยพื้นฐานแล้ว ขั้นตอนในการอัปเดตไซต์ (เช่น เพื่อเผยแพร่โพสต์บล็อกใหม่) คือ:

1. แยก / โคลนพื้นที่เก็บข้อมูล
2. ทำการเปลี่ยนแปลงของคุณ
3. ทดสอบการเปลี่ยนแปลงของคุณ
4. ส่งคำขอดึง (PR) สำหรับการเปลี่ยนแปลง
5. ทันทีที่มีการรวม PR การเปลี่ยนแปลงของคุณจะถูกเผยแพร่ทันที

มีคำแนะนำสำหรับแต่ละขั้นตอนด้านล่าง คำแนะนำจะถือว่าผู้ที่มีประสบการณ์ด้าน git/GitHub/ด้านเทคนิคน้อยกว่ากำลังทำงานอยู่ ผู้ที่มีประสบการณ์มากกว่าสามารถคาดการณ์ได้ตามนั้น -

แยก / โคลนพื้นที่เก็บข้อมูล

แม้ว่าคุณ จะสามารถ ทำงานบนพื้นที่เก็บข้อมูลนี้ได้โดยตรง แต่แนวปฏิบัติที่ดีที่สุดก็คือคุณทำไม่ได้ แต่คุณสามารถแยกหรือโคลน repo แล้วทำการเปลี่ยนแปลงกับสำเนานั้นได้ ซึ่งช่วยให้สามารถทดสอบก่อนทำการเปลี่ยนแปลงได้จริง และลดความเสี่ยงของการเปลี่ยนแปลงที่มีรูปแบบไม่ดีหรือการใช้คำที่หายไปจากโลกภายนอก

วิธีแยกที่เก็บ:

1. คลิกทางแยกที่ด้านบนของหน้า
2. เลือกบัญชี/องค์กรปลายทางสำหรับสำเนาของ repo
3. รอให้ทุกอย่างถูกคัดลอกไป

เอาล่ะ! นั่นคือทั้งหมดที่มีให้มัน

ทำการเปลี่ยนแปลงของคุณ

หากคุณกำลังเพิ่มโพสต์ในบล็อกใหม่ โปรดปฏิบัติตามกฎชื่อไฟล์เหล่านี้:

• วางโพสต์บล็อกทั้งหมดไว้ในไดเร็กทอรี _posts
• ขึ้นต้นชื่อไฟล์ด้วยวันที่ในรูปแบบ YYYY-MM-DD สิ่งนี้ สำคัญมาก เนื่องจากจะควบคุมลำดับที่เว็บไซต์แสดงโพสต์ในบล็อก
  • NOTA BENE : เว็บไซต์จะแสดงโพสต์ถึงวันที่และรวมถึงวันที่ปัจจุบัน ซึ่งจะทำให้คุณสามารถกำหนดเวลาการโพสต์ล่วงหน้าได้ แต่ก็หมายความว่าโพสต์ที่ลงวันที่ในอนาคตจะไม่ปรากฏ เว้นแต่คุณจะใช้ --future เมื่อทดสอบการเปลี่ยนแปลงของคุณ ในขณะนี้ คุณจำเป็นต้องทริกเกอร์การสร้างไซต์ใหม่ภายในหรือหลังวันที่กำหนด เพื่อให้โพสต์ปรากฏ ซึ่งสามารถทำได้ด้วย: git commit -m 'rebuild pages' --allow-empty && git push origin main หรือโดยทำการเปลี่ยนแปลงที่เกิดขึ้นจริงกับไซต์
• ตามด้วยวันที่ด้วยเครื่องหมายขีดกลาง ( - ) แล้วตามด้วยชื่อเรื่องที่คั่นด้วยเครื่องหมายขีดกลาง ชื่อนี้ไม่ปรากฏ มันเป็นเพียงการตั้งชื่อไฟล์ โปรดเขียนให้กระชับแต่มีคำอธิบาย
• ใช้นามสกุลไฟล์ .md เพื่อแสดงว่าโพสต์นั้นประกอบด้วยรูปแบบ Markdown (และโปรดเขียนโพสต์โดยใช้ Markdown เท่านั้น)

ตามกฎเหล่านี้ โพสต์ในบล็อกที่ประกาศการเปิด CFP ปี 2017 อาจมีชื่อไฟล์เป็น:

 2017-06-19-CFP-open.md

โปรดเพิ่มสิ่งต่อไปนี้ที่ด้านบนของไฟล์ด้วย:

 ---
layout: post
title: 'Example Title'
status: publish
type: post
published: true
categories: news
tags: '2013'
---

ตั้ง title ให้กับชื่อโพสต์ในบล็อกของคุณและแก้ไข tags เพื่อรวมปีการประชุมที่โพสต์นั้นเชื่อมโยงอยู่ (เว้นว่างไว้หากไม่มี) โปรดปล่อยค่าที่เหลือไว้ตามที่เป็นอยู่

สำหรับเนื้อหาไฟล์จริง คุณสามารถทำการเปลี่ยนแปลงได้บนเว็บอินเทอร์เฟซ GitHub หรือบนเครื่องภายในของคุณ

บน GitHub

1. นำทางไปยังไดเร็กทอรีที่มีไฟล์ที่คุณต้องการแก้ไขหรือเพิ่ม (อาจเป็น _posts )
2. หากต้องการสร้างไฟล์ใหม่:
   • คลิก Create a new file
   • ตั้งชื่อไฟล์ของคุณ (ตามคำแนะนำด้านบนหากเป็นโพสต์ในบล็อก)
3. ทำการเปลี่ยนแปลงของคุณ
   • หากต้องการสร้างไฟล์ใหม่:
     • คลิก Create a new file
     • ป้อนชื่อไฟล์ (ตามคำแนะนำด้านบนหากเป็นโพสต์ในบล็อก)
   • หากต้องการแก้ไขไฟล์ที่มีอยู่:
     • คลิกที่ไฟล์เพื่อเลือก
     • คลิกที่ไอคอนดินสอเล็กๆ
   • ไม่ว่าจะด้วยวิธีใด ตอนนี้คุณสามารถแก้ไขไฟล์ได้ในเว็บอินเตอร์เฟส
4. ยืนยันการเปลี่ยนแปลงของคุณโดยใช้แบบฟอร์ม Commit changes ด้านล่างอินเทอร์เฟซการแก้ไข
   • ป้อนชื่อสั้นๆ แต่สื่อความหมาย เช่น "การเพิ่มประกาศเปิด CFP ปี 2017"
   • ป้อนคำอธิบายโดยละเอียด หากคุณกำลังแก้ไขปัญหา โปรดอ้างอิงหมายเลขปัญหาที่นี่ ใช้เครื่องหมายแฮช ( # ) ตามด้วยหมายเลขปัญหา ( #74 ) สิ่งนี้จะเชื่อมโยงโดยอัตโนมัติในคำขอดึงซึ่งมีประโยชน์มาก

บนเครื่องท้องถิ่นของคุณ

TBD (สันนิษฐานว่าเป็นผู้ที่ใช้ git บนเครื่องในพื้นที่ของตนรู้เรื่องนี้อยู่แล้ว จะ กรอกข้อมูลในภายหลัง)

1. โคลนส้อมของคุณ
2. ทำการเปลี่ยนแปลงของคุณ (เพิ่มและ/หรือแก้ไขไฟล์)
3. ยอมรับการเปลี่ยนแปลงของคุณกลับไปที่ทางแยกของคุณ

ทดสอบการเปลี่ยนแปลงของคุณ

โปรดทดสอบการเปลี่ยนแปลงทั้งหมดในเครื่องก่อนที่จะพุชไปที่ GitHub

เซิร์ฟเวอร์การพัฒนาท้องถิ่น

การเริ่มต้นเซิร์ฟเวอร์การพัฒนาท้องถิ่นจะทำให้สำเนาของไซต์ของคุณพร้อมใช้งานที่ http://localhost:4000 มีหลายวิธีในการรันเซิร์ฟเวอร์ เลือกของคุณ!

ตัวเลือกที่ 1: โลหะเปลือย

การพึ่งพา:

• ทับทิม
• บันเดิล

การตั้งค่าครั้งเดียว:

bundle install

เริ่มเซิร์ฟเวอร์:

bundle exec jekyll serve --watch

หากต้องการดูตัวอย่างโพสต์ในอนาคตและโพสต์ที่ยังไม่ได้เผยแพร่ ให้เพิ่ม --future --unpublished ในคำสั่งด้านบน

ตัวเลือกที่ 2: บรรจุในภาชนะ

การพึ่งพา:

• นักเทียบท่า (หรือ Podman แทนที่ docker ด้วย podman )

การตั้งค่าครั้งเดียว:

docker build --tag ' seagldev ' ' . '

เริ่มเซิร์ฟเวอร์:

docker run --rm --interactive --tty --publish ' 4000:4000 ' --volume " $PWD :/usr/src/app " ' seagldev '

หากต้องการดูตัวอย่างโพสต์ในอนาคตและโพสต์ที่ยังไม่ได้เผยแพร่ ให้เพิ่ม --future --unpublished ต่อท้ายคำสั่งด้านบน

ส่งคำขอดึง (PR) สำหรับการเปลี่ยนแปลง

คุณสามารถส่ง PR ในอินเทอร์เฟซ GitHub หรือจากเครื่องภายในเครื่องของคุณได้

บน GitHub

1. บนเบราว์เซอร์ของคุณ ให้ไปที่ทางแยกของ repo seagl.github.io
2. คลิกในแท็บ Pull requests
3. คลิก New pull request button
4. GitHub รับรู้ว่า repo ของคุณเป็นทางแยก และค่าเริ่มต้นคือการให้ PR เป็นสาขาหลักของทางแยกของคุณที่ร้องขอเทียบกับสาขาหลักของ seagl.github.io อัตราต่อรองดีมาก นี่คือสิ่งที่คุณต้องการ ถ้าไม่เช่นนั้น คุณจะรู้มากพอที่จะตระหนักถึงสิ่งนี้ -
5. คลิก Create pull request
6. ป้อนชื่อสั้นๆ แต่สื่อความหมาย เช่น "การเพิ่มประกาศเปิด CFP ปี 2017"
7. ป้อนคำอธิบายโดยละเอียด หากคุณกำลังแก้ไขปัญหา โปรดอ้างอิงหมายเลขปัญหาที่นี่ ใช้เครื่องหมายแฮช ( # ) ตามด้วยหมายเลขปัญหา ( #74 ) สิ่งนี้จะเชื่อมโยงโดยอัตโนมัติในคำขอดึงซึ่งมีประโยชน์มาก
8. เลือก [Allow edits from maintainers](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) เพื่อให้สมาชิกในทีมคนอื่นๆ สามารถทำการแก้ไขได้ หากจำเป็น
9. คลิก Create pull request

บนเครื่องท้องถิ่นของคุณ

TBD (สันนิษฐานว่าเป็นผู้ที่ใช้ git บนเครื่องในพื้นที่ของตนรู้เรื่องนี้อยู่แล้ว จะ กรอกข้อมูลในภายหลัง)

การเปลี่ยนแปลงของคุณจะถูกเผยแพร่ทันที

ตอนนี้บางคน (บางทีอาจเป็นคุณ หากคุณมีสิทธิ์เข้าถึง Repo ระดับนั้น) ต้องตรวจสอบและรวมคำขอดึงของคุณ

เมื่อรวมคำขอดึงของคุณแล้ว จะมีการเผยแพร่บนเว็บไซต์

NOTA BENE : การผสานตัวเองจะไม่ทำให้เกิดการสร้างไซต์ใหม่ หากต้องการสร้างไซต์ใหม่ คุณจะต้องกดคอมมิตว่างดังนี้:

git commit --allow-empty -m " Rebuild the site, please " && git push

วิธีเพิ่มรูปภาพในโพสต์

เพิ่มรูปภาพของคุณลงในไดเร็กทอรี img/posts/ จากนั้นใช้มาร์กดาวน์ต่อไปนี้:

 ![ Example description ] ( /img/posts/example.jpg )

เคล็ดลับ:

• หากต้องการจัดแนวรูปภาพไปทางด้านข้าง ให้เพิ่มคลาส align-left หรือ align-right :

   ![ Example description ] ( /img/posts/example.jpg ) {:.align-left}

• เพื่อประโยชน์ของเวลาในการโหลดหน้าเว็บ ให้ปรับขนาดรูปภาพให้มีขนาดที่เหมาะสมก่อนนำไปใช้ในโพสต์

เก็บถาวรการประชุมที่ผ่านมา

การประชุมที่ผ่านมาจะถูกจัดเก็บแบบคงที่เป็นคอลเลกชัน Jekyll:

• archive-conferences
• archive-sessions

หากต้องการสร้างไฟล์เก็บถาวรของปีที่กำหนด ให้นำเข้าข้อมูลจากกำหนดการก่อน—

bundle exec rake import[2020]

—จากนั้นแก้ไขไฟล์เก็บถาวรด้วยตนเองหากจำเป็นต้องแก้ไขใดๆ