Dự án Linux Foundation

Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.

Tóm tắt dự án

Tổ chức nguồn mở:
The Linux Foundation
Người viết nội dung kỹ thuật:
jaskiratsingh2000
Tên dự án:
CHAOSS: Tạo sổ tay hướng dẫn CHAOSS cho toàn cộng đồng
Thời lượng dự án:
Thời hạn tiêu chuẩn (3 tháng)

Mô tả dự án

TÓM TẮT DỰ ÁN:

Hiện tại, các nhóm làm việc trong cộng đồng CHAOSS đã phát triển cách làm việc riêng và ghi lại các quy trình khác nhau ở mức độ khác nhau. Các nhóm làm việc bao gồm các nhóm làm việc như Common Metrics (WG), Diversity &Inclusion (WG), WG (Sự đa dạng và hoà nhập), Evolution, Risk (Rủi ro) và Value (Giá trị) và đã thiết lập cách thức tham gia và làm việc, đồng thời điều chỉnh nhiều cách thức giao tiếp và văn hoá làm việc. Các nhóm làm việc này tuân theo các chỉ số có các lĩnh vực và nền tảng tập trung khác nhau phù hợp với các chỉ số thích hợp, dẫn dắt nhiều nghiên cứu và phát triển trong danh mục nhóm làm việc tương ứng và biết lộ trình phù hợp để dẫn dắt nhiều nghiên cứu và phát triển trong các danh mục tương ứng, nhưng các quy trình dành cho người mới và những người đóng góp hiện tại có thể không biết cách tham gia hoặc đi theo lộ trình phù hợp cho các hoạt động tương ứng.

Do đó, các hoạt động trong cộng đồng CHAOSS không được chuẩn hoá. Do đó, để nắm được quy trình phù hợp và các nguyên tắc cơ bản về văn hoá làm việc trong toàn cộng đồng, mục tiêu của sổ tay cộng đồng là tập trung thông tin quan trọng và chuẩn hoá các phần thông tin đó trong dự án CHAOSS. Các phần thông tin quan trọng và chuẩn hoá chủ yếu tập trung vào các quy trình mà CHAOSS sử dụng để CHAOSS có thoả thuận về cách cộng đồng hoàn thành công việc, cách người mới có thể tham gia và tuân theo các nguyên tắc cơ bản của cộng đồng, cũng như những quy trình và lộ trình mà người mới hoặc thành viên hiện tại phải tuân theo để có thể lãnh đạo trong cộng đồng CHAOSS.

Sách hướng dẫn này sẽ đóng vai trò là sách hướng dẫn cho các thành viên hiện tại và mới của cộng đồng về cách hoàn thành công việc trong dự án CHAOSS. Dự án này bao gồm một thành phần sáng tạo để thu thập và sắp xếp nội dung cho sách hướng dẫn, cũng như một thành phần kỹ thuật để xác định cách trình bày sách hướng dẫn.

TẠI SAO CẦN CÓ?

Sổ tay cộng đồng là tài liệu xác định các chính sách và quy trình chính của cộng đồng, đồng thời nêu rõ sứ mệnh, giá trị và cách hoạt động của cộng đồng.

Sách hướng dẫn này cung cấp thông tin giới thiệu và cách hoạt động rõ ràng cho những thành viên mới tham gia cộng đồng. Hiện tại, Sổ tay cộng đồng CHAOSS có trên kho lưu trữ GitHub và cần được cải tiến và tái cấu trúc với nhiều thông tin hơn cho người mới và người dùng hiện tại của cộng đồng. Vì vậy, cuốn sách hướng dẫn dành cho toàn bộ cộng đồng CHAOSS này sẽ giúp những người mới và thành viên hiện tại của cộng đồng theo những cách sau:

  • Chính thức hoá và sắp xếp các chính sách của cộng đồng CHAOSS, tập hợp tất cả các chính sách ở một nơi
  • Thông báo về Giới thiệu, Sứ mệnh, Tầm nhìn và ban lãnh đạo của cộng đồng
  • Tìm hiểu các phương pháp của cộng đồng CHAOSS
  • Nguyên tắc đóng góp
  • Xác định quy trình công việc của dự án
  • Giới thiệu về văn hoá của cộng đồng CHAOSS
  • Câu hỏi chung thường gặp
  • Khả năng cố vấn

MÔ TẢ DỰ ÁN:

Sổ tay hướng dẫn dành cho cộng đồng sẽ được chia thành nhiều “Chuyên mục” chứa thông tin chi tiết và phù hợp về các chủ đề cụ thể. Có thể chia các phần này theo những cách sau:

  • Giới thiệu
  • Phương pháp của Cộng đồng CHAOSS
  • Lộ trình lãnh đạo
  • Thuật ngữ
  • Nguyên tắc đóng góp
    • Nhà phát triển
    • Nhà thiết kế
    • Writer
    • Nhà tiếp thị
  • Chỉ số
  • CHAOSScon
  • CHAOSScast
  • Video trong cuộc họp
  • Câu hỏi thường gặp chung
  • Chương trình cố vấn
    • Google Summer of Code
    • Hỗ trợ
    • Season of Docs của Google

NỘI DUNG GIAO DỊCH CHI TIẾT CỦA DỰ ÁN

1.) Giới thiệu:

Phần này sẽ đóng vai trò là trang đầu tiên của sách hướng dẫn cộng đồng CHAOSS, đồng thời sẽ trình bày thông tin chi tiết, thông tin tổng quan và cách sử dụng Sách hướng dẫn. Sau đây là những điều sau:

A.) Tài liệu này sẽ có Thông điệp chào mừng cùng với nội dung mô tả ngắn gọn về Cộng đồng CHAOSS nhằm giúp thuyết phục độc giả truy cập Sổ tay hướng dẫn. Tôi cũng sẽ thêm ảnh ghép lấy từ đây https://chaoss.community/chaoss-photo-album/ để làm nổi bật nhiều phong trào trong cộng đồng. B.) Trang này cũng chứa thông tin chi tiết về tất cả các phần với một dòng mô tả giải thích từng phần và các đường liên kết thích hợp. C.) Cách sử dụng sách hướng dẫn: Cách sử dụng sách hướng dẫn đã có tại đây( shorturl.at/cqQU6 ) nhưng tôi sẽ cải tiến và tái cấu trúc cách sử dụng sách hướng dẫn hiện có bằng cách sử dụng markdown tốt hơn, bao gồm cả Luồng của sách hướng dẫn(Tôi sẽ bao gồm cách mọi thứ diễn ra khi ai đó muốn thêm, xoá hoặc thảo luận về những điều liên quan đến sách hướng dẫn. Việc này có thể theo dõi quá trình giao tiếp đối với mọi thông tin liên quan đến sổ tay.), Nguyên tắc về sách hướng dẫn(bao gồm cả cách sử dụng trong cộng đồng và phạm vi), Đóng góp cho sách hướng dẫn ( bao gồm cả cách sử dụng kho lưu trữ để thực hiện thay đổi, tạo PR, Mẫu để làm theo khi thực hiện thay đổi đối với Sách hướng dẫn và Nguyên tắc về kiểu) và Chia sẻ ý kiến phản hồi về Sách hướng dẫn. Trong phần Chia sẻ ý kiến phản hồi, tôi sẽ cung cấp một mẫu và nhiều cách để người dùng có thể tiếp tục cung cấp hoặc sử dụng các vấn đề trên GitLab để nhận ý kiến phản hồi.

2.) Cách cộng đồng của CHAOSS:

Cách thức cộng đồng của CHAOSS rất quan trọng để mọi người hiểu rõ các nguyên tắc và thực hành cộng đồng. Quy trình công việc sẽ giúp làm nổi bật và trình bày các phương pháp hay nhất trong cộng đồng. Phần này bao gồm những nội dung sau:

A.) Giá trị chung: Nêu rõ cách xử lý các giá trị Bền vững, Cởi mở và Minh bạch trong Cộng đồng CHAOSS. Tôi sẽ giải thích về những giá trị này mà người dùng mới hoặc người dùng hiện tại nên hiểu và cân nhắc khi làm việc với cộng đồng. B.) Nguyên tắc cộng đồng: Bao gồm cả cách tham gia Cộng đồng CHAOSS và tuân thủ các điều khoản cơ bản. Nội dung này cũng sẽ giải thích về văn hoá làm việc mà cộng đồng mang lại. (Những việc nên làm và không nên làm). Tài liệu này sẽ bao gồm danh sách kiểm tra dành cho cộng tác viên/người duy trì cốt lõi, đồng thời cho người khác biết cách họ nên làm việc với người duy trì và danh sách kiểm tra của họ. C.) Nhóm làm việc: Trang này( https://chaoss.community/participate/ ) chứa thông tin về các Nhóm làm việc như Nội dung mô tả về Nhóm làm việc, đường liên kết đến kho lưu trữ và thông tin về cuộc họp. Tuy nhiên, trong sách hướng dẫn, tôi sẽ đề cập đến cách tham gia các nhóm làm việc khác nhau và hiểu quy trình đánh giá các chỉ số, hiểu văn hóa làm việc của Nhóm làm việc tương ứng và cách trở thành cộng tác viên cốt lõi cho các nhóm làm việc khác nhau.

3.) Lộ trình lãnh đạo:

Tuy việc giành quyền lãnh đạo trong một dự án nguồn mở có thể đóng vai trò quan trọng đối với thành công của cộng đồng trong thế giới thương mại. Vì vậy, tôi sẽ cân nhắc những điều sau:

A.) Nhóm lãnh đạo kỹ thuật: Nhóm này sẽ bao gồm các quy trình và trách nhiệm của Người duy trì kho lưu trữ, Người viết tài liệu và Người duy trì trang web B.) Lãnh đạo quản trị: bao gồm các lộ trình cho thành viên Hội đồng quản trị và Người ra quyết định C.) Kỹ năng lãnh đạo hoạt động: Chương trình này sẽ cung cấp lộ trình dành cho Nhà quản lý cộng đồng

4.) Thuật ngữ:

Thuật ngữ sẽ giúp mô tả các thuật ngữ và tài sản tương ứng thường được sử dụng trong cộng đồng CHAOSS. Ngoài ra, tôi cũng sẽ đưa vào các nguyên tắc sử dụng thuật ngữ như Cách viết hoa, Chữ viết tắt và Những từ cần tránh cùng lý do. Các thuật ngữ sẽ được đưa vào bao gồm Dự án CHAOSS, Tình trạng cộng đồng nguồn mở, Bài đánh giá mã, Nhóm làm việc, Chỉ số phần mềm nguồn mở, Chỉ số phổ biến, Chỉ số về sự đa dạng và hòa nhập, Nhóm làm việc về sự phát triển, Nhóm làm việc về rủi ro, Nhóm làm việc về giá trị, Bản phát hành chỉ số, Khu vực trọng tâm.

5.) Nguyên tắc đóng góp:

Đây là bối cảnh chính của mọi cộng đồng nguồn mở vì hầu hết cộng đồng nguồn mở đều phụ thuộc vào các hoạt động đóng góp hoặc làm việc tình nguyện. Vì vậy, điều này sẽ giúp mọi người mới/người dùng tham gia cộng đồng hiểu được những điều cần thiết và nguyên tắc cơ bản mà họ phải tuân thủ. Vì vậy, điều này sẽ bao gồm các chi tiết sau:

A.) Tìm hiểu lộ trình của cộng đồng: Chủ đề này sẽ cung cấp thông tin tổng quan về lộ trình của cộng đồng CHAOSS, giúp người dùng biết cách hoặc quy trình ưu tiên các hoạt động trong Dự án CHAOSS. B.) Giải thích những điều cần thiết để thực hiện bất kỳ đóng góp nào như phát triển, Tài liệu, Thiết kế, Thử nghiệm, v.v. C.) Giới thiệu ngắn gọn về cách hoạt động của GitLab D.) Hướng dẫn dành cho người đánh giá/người duy trì

Phần này cũng sẽ chứa "Vai trò và trách nhiệm" cho từng danh mục Đóng góp như bên dưới:

a.) THIẾT KẾ: Tiểu mục này sẽ bao gồm "Quy trình thiết kế CHAOSS" và Nguyên tắc thiết kế, Quy trình và Công cụ sử dụng mà những người đóng góp phải tuân thủ trong khi đóng góp cho lĩnh vực thiết kế. b.) PHÁT TRIỂN: Phần này sẽ chứa hướng dẫn đóng góp cho cơ sở mã. Tài liệu này sẽ chứa các yêu cầu kỹ thuật, Cấu trúc dự án, Thiết lập dự án(Augur, Cregit, GremoireLab) c.) TÀI LIỆU: Bao gồm Tài nguyên cho Tài liệu, bao gồm cả công cụ và Hướng dẫn về kiểu. d.) TƯƠNG TÁC: Nội dung này sẽ bao gồm cách những người đóng góp có thể hỗ trợ cộng đồng CHAOSS trong việc phát triển hoạt động tiếp cận – Viết blog, Sử dụng tên người dùng trên mạng xã hội, Tổ chức các cuộc gặp gỡ và sự kiện

6.) Chỉ số

Hiện tại, trang web cộng đồng CHAOSS chứa thông tin về Bản phát hành chỉ số( https://chaoss.community/metrics/ ) và điều quan trọng hơn là mọi người cần hiểu cách làm theo quy trình để đưa trang web chỉ số của họ lên trang web đó. Vì vậy, phần này sẽ cung cấp thông tin giúp người dùng nắm được các quy trình và cách thức để phát hành chỉ số của riêng họ.

7.) CHAOSScon:

Thông tin về CHAOSScon đã có trên GitHub( https://github.com/chaoss/governance/blob/master/community-handbook/chaosscon.md ) và Trang web( https://chaoss.community/CHAOSScon-2020-NA/ ) nhưng sẽ hợp lý hơn nếu thêm thông tin chi tiết và thông tin giải thích quy trình cũng như cách quản lý CHAOSScon trong Sổ tay. Trong Sổ tay này sẽ chứa các thông tin sau:

A.) Thông tin chi tiết về Ban tổ chức: Nội dung này sẽ giải thích các quy trình tham gia ban tổ chức CHAOSScon B.) Quản lý quy trình kêu gọi đề xuất: Quy trình này sẽ bao gồm việc quản lý việc đăng ký tác giả, gửi đề xuất và tài liệu, quy trình xem xét và phê duyệt. C.) Quản lý và phát hành chương trình CHAOSScon D.) Cách quản lý Nội dung quảng cáo và tiếp thị E.) Cách xử lý đề xuất tài trợ và các khoản tiền bao gồm Gói

8.) CHAOSScast:

Thông tin về CHAOSScast có tại đây https://github.com/chaoss/governance/blob/master/community-handbook/chaosscast.md và sẽ được đưa vào Sổ tay cùng với một số thông tin chi tiết khác như Tham gia, Ban tổ chức, Quảng cáo và Tài liệu tiếp thị.

9.) Video cuộc họp:

Tệp này sẽ chứa tất cả video về cuộc họp cùng với nội dung mô tả, chẳng hạn như Người tham dự, Chương trình làm việc, v.v. đã diễn ra trước đây và có trên YouTube.

10.) Câu hỏi chung thường gặp:

Những câu hỏi này sẽ bao gồm các câu hỏi chung thường được đặt ra trong cộng đồng. Điều này sẽ giúp người mới và các thành viên hiện tại của cộng đồng trả lời một số câu hỏi.

11.) Mùa hè viết mã của Google:

Phần này sẽ chứa thông tin về Google Summer of Code, Tiêu chí tham gia và thông tin về cách mọi người có thể tham gia Google Summer of Code trong cộng đồng CHAOSS. Phần này cũng sẽ chứa Mẫu đề xuất mà mọi người có thể sử dụng để soạn thảo đề xuất cũng như vai trò và trách nhiệm. Ngoài ra, trang này cũng sẽ cung cấp thông tin giúp các thành viên hiện tại của cộng đồng tìm hiểu quy trình trở thành quản trị viên tổ chức và người cố vấn.

  1. Outreachy:

Phần này sẽ chứa thông tin về Outreachy, Tiêu chí tham gia và thông tin về cách mọi người có thể tham gia cộng đồng CHAOSS trong Outreachy.Phần này sẽ chứa các vai trò và trách nhiệm, bao gồm cả quy trình trở thành quản trị viên tổ chức và cố vấn.

  1. Season of Docs của Google:

Phần này sẽ có thông tin về GSoD, Tiêu chí đủ điều kiện và thông tin về cách mọi người có thể tham gia trong cộng đồng CHAOSS của GSoD. Tài liệu này sẽ trình bày các vai trò và trách nhiệm, bao gồm cả quy trình trở thành quản trị viên tổ chức và người cố vấn.

KẾT QUẢ MONG MUỐN DỰ ÁN:

Sổ tay đóng vai trò quan trọng trong mọi cộng đồng. Tương tự, cuốn sách hướng dẫn dành cho toàn bộ cộng đồng CHAOSS này sẽ giúp tài liệu của cộng đồng CHAOSS được sắp xếp và trình bày chi tiết hơn. Mọi người mới tham gia cộng đồng cũng như các thành viên hiện tại trong cộng đồng sẽ dễ dàng hiểu được những nguyên tắc cơ bản và cách hoạt động của cộng đồng CHAOSS. Hơn nữa, cuốn sách hướng dẫn này sẽ giúp bạn có được nhiều quy trình và lộ trình cho các nền văn hoá làm việc khác nhau trong cộng đồng CHAOSS.

THÔNG TIN CHI TIẾT VỀ KỸ THUẬT:

Tôi đề xuất sử dụng nền tảng Gitbook để duy trì sách hướng dẫn này vì đây là một dự án cộng tác, thân thiện với người dùng để các nhóm làm việc hiệu quả hơn. Một số tính năng của nền tảng GitBook:

  • WYSIWYG: Trình soạn thảo văn bản mạnh mẽ nhưng vẫn đẹp mắt
  • Markdown: Hỗ trợ hiệu quả và mạnh mẽ cho các lối tắt trong Markdown
  • Khả năng nhúng đa dạng thức: Nhúng nội dung trên web bên ngoài như video, đoạn mã, bài viết, nhạc và nhiều nội dung khác
  • Trang tổng quan dành cho nhà văn: Có trang tổng quan thông minh dành cho nhà văn, hỗ trợ tính năng chỉnh sửa bằng hình ảnh
  • Bản nháp: soạn các thay đổi mới và cộng tác không đồng bộ
  • Bình luận hỗ trợ: Thảo luận và xem xét các thay đổi nháp
  • Theo dõi nhật ký viết: Theo dõi mọi thứ. Xem xét và huỷ bỏ các thay đổi
  • Thông tin chi tiết: Công cụ này cũng hỗ trợ thông tin chi tiết giúp theo dõi lưu lượng truy cập, điểm xếp hạng và chất lượng nội dung
  • GitHub Sync: Duy trì quy trình làm việc và tiếp tục đồng bộ hoá tài liệu với GitHub
  • Tuỳ chỉnh thương hiệu: Miền tuỳ chỉnh, biểu trưng tuỳ chỉnh, phông chữ, màu sắc, giao diện, tiêu đề, v.v.

Sau đây là một số hình ảnh cho thấy sơ lược về nền tảng này

  • shorturl.at/GNQR4
  • shorturl.at/gATZ8
  • shorturl.at/qrE57
  • shorturl.at/rFRX6
  • shorturl.at/eyLW1
  • shorturl.at/rwHS8

– Sổ tay sẽ được lưu trữ ở đâu?

Sổ tay này sẽ được lưu trữ trên chính GitBook, nơi GitHub cung cấp cơ chế thích hợp cho Miền tuỳ chỉnh, Lỗi phổ biến và SEO.

Miền tuỳ chỉnh: Nếu cộng đồng CHAOSS muốn lưu trữ miền đó trên miền tuỳ chỉnh, thì miền đó sẽ hiển thị như sau: docs.chaoss.community. Tổ chức chỉ cần tạo bất kỳ miền con nào mà họ muốn có. Để thiết lập miền của Tổ chức, hãy chuyển đến phần cài đặt của tổ chức trên Nền tảng Gitbook. Ví dụ về hình ảnh: shorturl.at/GNQR4

Không gian GitBook được phân phát qua CDN của riêng chúng tôi và được bật HTTPS theo mặc định. Các chứng chỉ này do LetsEncrypt phát hành

Các miền được hỗ trợ:

  • Miền con: www.example.com
  • Miền tuỳ chỉnh: docs.example.com

-- Làm cách nào để đồng bộ hoá Gitbook với GitHub để có thể chỉnh sửa hiệu quả trên cả hai nền tảng?

Việc tích hợp với GitHub rất dễ sử dụng: nếu có người thay đổi nội dung trên GitBook, nội dung chỉnh sửa của họ sẽ được đẩy vào kho lưu trữ GitHub. Ngược lại, các thay đổi được đẩy vào kho lưu trữ GitHub sẽ được nhập trong GitBook.

Thiết lập tính năng Tích hợp GitHub:

  • Trong không gian của bạn trên nền tảng GitBook, hãy nhấp vào thẻ tích hợp > GitHub
  • Uỷ quyền cho GitBook truy cập vào tài khoản GitHub được liên kết với tổ chức của bạn
  • Chuyển đến GitHub của tổ chức và tạo một kho lưu trữ cho "Sách hướng dẫn", ví dụ: chaoss-handbook
  • Bây giờ, hãy chọn kho lưu trữ có tên chaoss-handbook mà bạn muốn kết nối trong tuỳ chọn uỷ quyền bên trong nền tảng GitBook.

Sau khi hoàn tất các bước này, GitBook sẽ thêm một webhook vào kho lưu trữ chaoss-handbook để cho phép kho lưu trữ này tìm nạp nội dung trên mọi thay đổi đối với kho lưu trữ. Khi bạn thực hiện thay đổi đối với GitBook, một bình luận mới sẽ được đẩy.

Vậy là xong! Bất kỳ ai cũng có thể tiếp tục chỉnh sửa từ GitBook hoặc kho lưu trữ GitHub.

-- Cách chỉnh sửa các trang trên nền tảng GitBook?

Bất kỳ ai muốn chỉnh sửa nội dung nào trong nền tảng GitBook đều phải tham gia nền tảng GitBook bằng lời mời hoặc đường liên kết tham gia. GitBook hỗ trợ tính năng chỉnh sửa trực quan, trong đó người dùng có thể trực tiếp viết trong các trang.

Bản nháp là phiên bản nội dung người dùng có thể chỉnh sửa mà chỉ người viết mới có thể truy cập và được tạo tự động khi bạn bắt đầu viết (chữ cái đầu tiên trên trình chỉnh sửa, tạo trang mới, tải ảnh lên, v.v.).

Các thay đổi được thực hiện trên bản nháp sẽ chỉ áp dụng cho bản nháp đó, cho phép người dùng cùng lúc đóng góp nội dung vào cùng một tài liệu với các thành viên khác mà không gây ra xung đột! Đây là những gì chúng ta gọi là chỉnh sửa không đồng bộ và giải quyết xung đột.

Phiên bản đầu tiên của bản nháp không phải lúc nào cũng sẵn sàng để xuất bản ngay lập tức. Sử dụng ""lưu"" khi bạn muốn tiếp tục công việc của mình sau hoặc nếu nội dung của bạn chưa sẵn sàng để "hợp nhất"".

Khi chỉnh sửa xong, bạn có thể ""hợp nhất"" bản nháp. Sau đó, nội dung bạn đã viết hoặc những thay đổi bạn đã thực hiện sẽ hiển thị cho các thành viên trong nhóm của bạn và/hoặc ở chế độ công khai.

Ví dụ về hình ảnh: shorturl.at/gATZ8 và shorturl.at/qrE57

– Cấu trúc nội dung:

Mục lục: Mỗi không gian có thể chứa số trang bất kỳ mà bạn cần để viết tài liệu. Tất cả những trang này đều hiển thị ở phía bên trái màn hình trong cái mà chúng tôi gọi là Mục lục. Trong mục lục, bạn có thể quản lý các trang: tạo trang mới, nhóm trang, thêm đường liên kết bên ngoài, thêm biến thể, nhập tài liệu bên ngoài như trang web hoặc tệp Markdown (.md hoặc .markdown), HTML (.html), Microsoft Word (.docx).

Trang ban đầu: Trang ban đầu là trang chủ hoặc trang gốc của tài liệu và về cơ bản hoạt động như trang chính của tất cả các trang trong tài liệu. Vì đây là trang chính của tài liệu và không gian của bạn, nên bạn không thể di chuyển, xoá, tạo trang con hoặc đặt trang này trong một nhóm.

Trang: Trang có tiêu đề, là phần mô tả không bắt buộc ở đầu trình chỉnh sửa. Sau đó, bạn có thể viết và thêm bất kỳ loại nội dung nào vào trang đó.‌ Bạn có thể lồng các trang bằng cách kéo và thả một trang bên dưới một trang khác. Các phần tử con của một trang sẽ bị ẩn nhưng có thể được thu gọn.

Đường liên kết ngoài: Đây là các mục nhập là đường liên kết ngoài và không có nội dung nào trong trình chỉnh sửa. Chức năng chính của các đường liên kết này là liên kết đến các trang web bên ngoài.

Biến thể: Bạn có thể tạo nội dung thay thế cho tài liệu bằng cách tạo một biến thể. Điều này có thể hữu ích trong việc ghi lại nhiều phiên bản của một API, thư viện hoặc bản dịch.

Ví dụ về hình ảnh: shorturl.at/eyLW1 và shorturl.at/rFRX6

-- Sách hướng dẫn sẽ được trình bày như thế nào ở phía máy khách?

Người dùng có thể truy cập vào sách hướng dẫn cộng đồng Chaoss bằng một miền con có thể là https://docs.chaoss.community. Sách hướng dẫn này sẽ có giao diện như sau:

  • Sổ tay Mattermost – https://handbook.Geminimost.com/
  • Tài liệu về Cầu cộng đồng của Linux Foundation – https://docs.linuxfoundation.org/docs/ Và nhiều tài liệu khác

TIẾN TRÌNH DỰ ÁN:

1.) Giai đoạn gắn kết cộng đồng (17/8 – 13/9)

A.) Tuần 1-4:

  • Thảo luận về dự án với người cố vấn
  • Nghiên cứu và thu thập thông tin cần thiết cho các phần trong dự án, đặt câu hỏi làm rõ cho cộng đồng
  • Làm rõ với cộng đồng xem nên sử dụng nền tảng nào cho sổ tay này (tôi đề xuất sử dụng GitBook) và thiết lập nền tảng đó
  • Đóng góp cho các vấn đề về tài liệu

2.) Giai đoạn phát triển tài liệu (14/9 – 30/11)

A.) Tuần 5 (14/9 – 20/9)

  • Phần giới thiệu của "Bản nháp"

B.) Tuần 6 (21/9 – 27/9)

  • Bản nháp phần "Cách thức hoạt động của cộng đồng CHAOSS"

C.) Tuần 7 (28/9 — 4/10)

  • Soạn thảo phần "Con đường dẫn đến vai trò lãnh đạo"
  • Soạn thảo phần "Thuật ngữ"

D.) Tuần 8 (5/10 – 11/10)

  • Soạn bản thảo lộ trình của cộng đồng
  • Nguyên tắc đóng góp thiết kế nháp

E.) Tuần 9 (12/10 – 18/10)

  • Mục Phát triển bản nháp

F.) Tuần 10 (19/10 – 25/10)

  • Nguyên tắc về mục Viết và Tiếp cận

G.) Tuần 11 (26/10 – 1/11)

  • Mục Chỉ số nháp
  • Phần CHAOSScon nháp

H.) Tuần 12 (2 tháng 11 – 8 tháng 11)

  • Thiết kế phần cuộc họp

  • Bản nháp Câu hỏi thường gặp chung về cộng đồng

    I.) Tuần 13 (9/11 – 15/11)

  • Bản thảo về Nguyên tắc của GSoC

J.) Tuần 14 (16/11 – 22/11)

  • Bản nháp về Nguyên tắc của Outreachy

K.) Tuần 15 (23/11 – 29/11)

  • Thời gian đệm; Làm bóng và cải thiện toàn bộ tài liệu

3.) Giai đoạn đánh giá (30/11 – 5/12)

A.) Tuần 16:

  • Soạn báo cáo dự án
  • Điền thông tin đánh giá cho dự án

HÀNH VI TƯƠNG TÁC TRONG CỘNG ĐỒNG

1.) Tham gia và thảo luận với cộng đồng.

Tôi đã tham gia cộng đồng CHAOSS từ tháng 4 năm 2020 và tham gia nhiều cuộc thảo luận với các thành viên trong cộng đồng cũng như với các cố vấn dự án cụ thể của tôi( Georg Link và Armstrong Foundjem). Một trong những cuộc thảo luận như vậy đã thu hút được sự quan tâm lớn hơn của các thành viên trong cộng đồng là "Đề xuất Gitbook làm nền tảng lưu trữ Sổ tay Cộng đồng" và có thể tìm thấy trên chuỗi danh sách gửi thư từ kho lưu trữ CHAOSS có tên là Đề xuất Gitbook làm nền tảng lưu trữ Sổ tay cộng đồng. Tôi cũng tham gia các cuộc gọi hằng tuần với cộng đồng để cập nhật thông tin cho họ.

2.) Bạn sẽ thu thập thông tin cần thiết cho dự án này như thế nào?

Vì dự án này yêu cầu thiết lập sách hướng dẫn trên toàn cộng đồng, nên thông tin cần truy cập trong sách hướng dẫn sẽ được thu thập và thảo luận với các thành viên trong cộng đồng. Như đã đề xuất lịch trình nêu trên, tôi sẽ có thể thảo luận và thu thập thông tin cần thiết trong giai đoạn gắn kết cộng đồng.

Tôi sẽ nghiên cứu các phần khác nhau theo CHAOSS và tiếp tục các chuỗi thư trên danh sách gửi thư. Tôi sẽ cố gắng hỏi các câu hỏi làm rõ từ người cố vấn và cộng đồng tuỳ thuộc vào yêu cầu.

Để có các cuộc thảo luận ngắn gọn, tôi cũng sẽ tham gia các cuộc gọi hằng tuần.

3.) Bạn dự định sẽ thông báo cho cộng đồng về tiến trình cũng như mọi vấn đề hoặc câu hỏi mà bạn có thể gặp phải trong quá trình thực hiện dự án bằng cách nào?

Để linh hoạt và minh bạch, tôi sẽ cố gắng trao đổi qua cuộc thảo luận trên danh sách gửi thư để hỏi những điều tôi còn nghi ngờ.

Tôi sẽ chia sẻ tiến trình hằng tuần của mình dưới dạng một bài đăng trên blog. Bài đăng này sẽ bao gồm tài liệu về quy trình scrum và những thách thức mà tôi gặp phải. Bài đăng này sẽ được chia sẻ trên danh sách gửi thư của cộng đồng để tiếp cận nhiều đối tượng hơn trong tổ chức nguồn mở.

Tôi cũng sẽ tham dự các cuộc gọi hằng tuần với cộng đồng để đưa ra các đề xuất và thảo luận phù hợp về các vấn đề chính.

Tôi cũng dự định tạo một bảng Trello với các nhiệm vụ hằng tuần. Sau đó, cố vấn có thể sử dụng bảng này để hiểu rõ và súc tích về các vấn đề và tính năng hiện đang được khai thác.

4.) Bạn sẽ làm gì nếu gặp khó khăn với dự án và không có người cố vấn bên cạnh?

Tôi tin rằng vai trò của cố vấn là hướng dẫn học sinh đi đúng hướng chứ không phải giải thích mọi góc cạnh của vòng lặp cho học sinh. Học viên chịu trách nhiệm duy nhất về việc nghiên cứu và triển khai dự án. Xin lưu ý rằng tôi chỉ có thể nhờ người cố vấn giúp mình khi đó là phương án cuối cùng.

Tuy nhiên, nếu người cố vấn không có mặt/bận việc tại thời điểm tôi cần trợ giúp, thì tôi sẽ chuyển sang chia sẻ vấn đề mình gặp phải trong cộng đồng CHAOSS. Tôi chắc chắn rằng sẽ có người có thể giúp tôi giải quyết mọi khó khăn mà tôi gặp phải. Tôi cũng sẽ chia sẻ vấn đề này trên các diễn đàn trực tuyến/cộng đồng nhà phát triển như dev.to

Ngoài ra, tôi sẽ cố gắng tham gia mọi cuộc gọi trợ giúp hằng tuần trong cộng đồng CHAOSS để hỏi những điều mình còn thắc mắc.