ocftw / oscvpass Goto Github PK

與 Pretalx 相關的事項。

建立

• #3

使用測試

• #14

中文化

• #13

2023/07/24 - 2023/07/28 週目標，建立 Pretalx 在 Azure，並可以提出申請 OSCVPass 狀態。

• Domain name 申請：apply-for-oscvpass.ocf.tw
• HTTPS/SSL 憑證：https://github.com/dehydrated-io/dehydrated
  • SSL Report, A+
• nginx 設定：SSL Configuration Generator
• Pretalx config, production ready
• SMTP, mail.
• Create event
• Announcement
  • COSCUP, OSCVPass (eligible)

Azure Instance:

• @ChAoSUnItY's SSH Key

登入後的操作

tmux ls 列出目前已建立的 session
tmux a 使用最近的 session
tmux 建立新的 session

Ctrl + a, s 切換 session
Ctrl + a, w 切換視窗
Ctrl + a, c 建立視窗
Ctrl + a, x 關閉視窗
Ctrl + a, d 跳出 tmux

使用某一這設定檔的 docker compose

# 測試版本
docker compose -f ./docker-compose.yml up

# 正式版本
docker compose -f ./docker-compose_prod.yml up

目前狀態

若申請表單中申請方勾選同意收錄，則將申請表單中的案例編入至 OSCVPass 專案介紹頁面。

衍生問題

由於採用手工收錄，導致收錄程序上較為複雜。

未來計畫

預計使用圖形化介面並串接申請資料來簡化收錄流程。

相關 Issues & PRs

目前Pretalx雖然能設定部分欄位為"Do not ask" (意即不需要填寫)，但由於Pretalx的設計定位是供Conference使用，有2個欄位分別為"Proposal title"和"Additional Speaker"無法設定為"Do not ask"。

參見

• ref: pretalx/pretalx#1522

引導申請人在申請時可以初步的檢查。例如：

1. 是否在一年內的貢獻？
2. 是否有在專案內宣告授權條款？
3. 是否與開源領域相關的貢獻？
4. 是否有在 FSF、OSI 認可的授權類型？
5. 所提交的申請證明與申請人關聯是否為本人？

目前分類可參照這裡，但需要更為具體且開放的分類方法。

以 #18 所討論使用 mdbook 來建立。

待確定項目：

• 是否針對文件額外建立新的 repo，或是將文件部分存放在 ./docs 底下。
  • output.html.site-url
• Hosting: Github or where?
• Github actions for generating the docs.

Host on Github

1. Create branch: docs
2. Github Actions (trigger by push to main)
3. mdbook build in Github Actions, and push to branch: docs with GITHUB_DEPLOY_KEY

ref: Automated Deployment: GitHub Actions

Result

https://oscvpass.ocf.tw/docs/

nojekyll

Add .nojekyll in the root source.

ref: Static site generators

目前狀態

使用 Google Form 填寫表格，並將表單回饋發送至 Google Spreadsheets 上供志工審核。

衍生問題

N/A

未來計畫

將 Google Form 的表單回饋發送至自行建立之 Pretalx，使用獨立 DB 儲存表單資訊及狀態。

或是使用 Pretalx 內建的表單來取代現有的 Google form。

代管選項

• AWS
• GCP
• Azure

資料庫選項

Pretalx

• redis
• PostgreSQL

其他額外建立

• Firebase
• MySQL
• MongoDB
• Redis

相關 Issues & PRs

• #3
• #17
• #18
• #24

目前狀態

將通知結果寄送至申請方的 email 信箱中。

衍生問題

目前是透過 toomore/COSCUP2013Secretary-Toolkit 專案底下 scripts/oscvpass 整理名單後手動發送。

未來計畫

• 與 Pretalx API 整合，從 Pretalx 取得申請者或貢獻者發送通知。
• 手工發送 scripts 從 COSCUP2013Secretary-Toolkit 搬移過來。 #31

相關 Issues & PRs

• #20
• #26
• #31

目前狀態

使用 Static Page 的方式架設供大眾參考，架設於 OSCVPass 專案介紹頁面。

衍生問題

需使用本地編輯器（例如 VSCode）在本地端編輯完成後使用 git commit 以及 git push 將更動推送至網頁上。

未來計畫

可以 Fork Pretalx 新增一個頁面用來呈現原本 OSCVPass 專案介紹頁面 的專案列表，並套用api新增專案條目。

相關 Issues & PRs

• #2
• #27

目前 Pretalx 在正體中文（zh-Hant）的翻譯進度為 64%，可以以一個活動或是翻譯工作坊的方式衝刺中文化翻譯進度。

官方多語系翻譯平台：https://translate.pretalx.com/projects/pretalx/pretalx/zh_Hant/

初步規劃

1. 參與正體中文化貢獻後可以直接取得 OSCVPass 一年資格或延展效期。
2. 需規劃活動進行方式：初步翻譯、校閱方式。
3. 參與者貢獻資格審核流程。

流程

建立可以架 Pretalx 的基本環境。

• Ubuntu 22.04
• Docker

Hi~ 昨天收到 [OSCVPass] 2022 年度總結的信發現現在網站上面有好多貢獻案例

不過網站的篇幅愈來愈長了，不知道是否有想過一些調整來更好呈現這些案例（如分頁、表格），另外信中的圖表統計也很適合直接做在網站上

不知道我能如何貢獻這個專案呢？

目前申請流程是寫在這裡。但未來若移植到Pretalx（或其他平台）上流程可能會有所不同，需要：

1. 尋找一個可靠，易用，且美觀的說明文件
   • README.md
     • 流程不宜歸納，容易造成文件過於擁擠
   • GitHub Wiki
     • 會因為md裡面的header導致右側的文件樹過於混亂
   • Media Wiki
     • 架設過於複雜
   • mdbook
     • 易用，且支援md渲染，建設容易
2. 於表單流程設計完成後，規劃文件內容。

Licenses for Open Source Development - Community Support
https://www.jetbrains.com/community/opensource/#support

@shengyou, @nfsnfs, @snoopy60313 提及 Jetbrains 有社群支持計畫，看看有無可能與 OSCVPass 合作的形式或可能。

目前無法成功寄出信件至使用者的信箱中

• AWS SES?
• pretalx 的 bug?

目前狀態

申請者能獲得有和 OSCVPass 合作的 Conference 的特別票種。

衍生問題

回饋的項目單一，誘因不足。

未來計畫

希望朝向多樣性的回饋。

相關 Issues & PRs

@toomore 委託 @ChAoSUnItY 協助審核。

針對文件系統已建立後，需要補足的部分。

文件架構：

1. 申請：申請說明與常見問題 Q&A

   • 如何貢獻教學 https://opensource.guide/how-to-contribute/

2. 社群：參與志工或是審核委員。

   • 開發：Pretalx 安裝過程 / 如何撰寫文件
     @ChAoSUnItY

3. 推薦專案：提供給具有 OSCVPass 資格的成員，提供專案簡介與招募成員。

   • https://firstcontributions.github.io/
   • https://opensourceindex.io/
   • https://www.codetriage.com/

相關的 PR 或 Issues：

• #32
• #35

寄送審核結果通知，並註明 HITCON 申請到 7/28 請把握時間。

目前狀態

將 Google Spreadsheets 上的申請上的申請狀態更動為待補件。

衍生問題

• #5

未來計畫

• #5

相關 Issues & PRs

在 COSCUP 擺攤時有被貢獻者提到沒有收到 Renew 的信件，可能之後在 COSCUP 開始前一兩個月要寄信給他們，記得回來更新。

目前狀態

於 Google Spreadsheets 上由不同委員來審核。

衍生問題

由於 Google Spreadsheets 上功能缺乏，且過往資料龐大，導致審核上會逐漸失去易用性。

未來計畫

串接 Pretalx 的 API 及其內建網頁，直接審核申請，且可查詢過往紀錄。

進階

或許可以再串接 API 到 Slack bot 上直接簡化審核流程？

相關 Issues & PRs

• 將發送 scripts 搬移到 OSCVPass 專案。
• 操作文件

目前狀態

藉由多個 Conference 的開源貢獻票來吸引現有或潛在的開源貢獻者前來申請，並藉由本計畫推廣開源文化。

衍生問題

• 開源推廣的推力不足？

未來計畫

參考國外的一些類似的活動：

Hacktoberfest

該活動於每年10月舉行，藉由獎勵制度提倡並推廣開源文化。

• 獎勵制度：參與者於該年 10 月內提交 4 個有效的 PR 並成功被 merge 到 master/main 後即可申請一系列獎品，例如量身訂製衣服、各類貼紙，或是兌換種植樹木（#Team Tree, 2021、2022）
• 潛在問題：
  • 變調的 Hacktoberfest 與 amazing project

Advent Of Code

該活動於每年 12 月 1 號舉行至 12 月 25 號，於聖誕節結束，主要透過類似 Leetcode 的 Daily challenge 來推動各程式語言及團體來分享解法。

• 參考案例：
  • rust-tw/advent-of-code
  • vlang/adventofcode

相關 Issues & PRs

• #13

Pretalx 建立後，需要扮演三種角色測試系統上的功能。

1. 活動建立者：某某研討會的議程組，需要建立一個徵稿活動，如何建立徵稿頁面？如何設定投稿人額外調查資訊的欄位。
2. 投稿人：投稿類型、貢獻類別（原始碼貢獻、推廣貢獻）。
3. 審稿委員：如何進入系統審稿？如何取得審稿標準與規範？審稿委員的帳號權限設定。

建立測試資料

1. install pip: docker exec -ti pretalx pip install Faker freezegun
2. in docker compose: docker exec -ti pretalx pretalx create_test_event

ref. https://docs.pretalx.org/administrator/commands.html#python-m-pretalx-create-test-event

Result

1. 各角色的使用流程
2. Pretalx 帳號權限設定與差異

預定時程

1. 7/10 - 7/14

目前(可能受制於 #26)無法提升一般用戶的權限至管理員。

結束實習前目前我們的進度到哪個部分。

1. 目前手邊的進度。
2. 未來可以持續的項目。
3. 其他：試過但沒有成果的項目。

目前狀態

將 Google Spreadsheets 上的申請轉移至 Google Spreadsheets 的審核通過頁面。

衍生問題

• #5

未來計畫

• #5

相關 Issues & PRs

8月值日生是 Toomore，需要協助審核並寄出通知

目前Pretalx僅支援在預設問題上增加其他額外問題，貌似無法更動部分預設問題。

設定

表單