Dự án Linux Foundation

Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Google Phần Tài liệu.

Tóm tắt dự án

Tổ chức nguồn mở:
Nền tảng Linux
Người viết nội dung kỹ thuật:
jaskiratsingh2000
Tên dự án:
CHAOSS: Tạo Sổ tay CHAOSS cho toàn cộng đồng
Thời lượng dự án:
Thời lượng 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 công tác trong cộng đồng CHAOSS đã xây dựng những phương thức làm việc riêng và ghi lại các quy trình riêng biệt ở nhiều mức độ. Các Nhóm công tác gồm có các nhóm Các chỉ số chung, Tính đa dạng và Hoà nhập, Sự phát triển, Rủi ro và Giá trị. Các nhóm này thiết lập những phương thức tham gia và làm việc riêng cũng như điều chỉnh văn hoá làm việc và giao tiếp. Các nhóm công tác theo các chỉ số này có các lĩnh vực trọng tâm và bối cảnh khác nhau phù hợp với các chỉ số phù hợp, dẫn dắt nhiều hoạt động nghiên cứu và phát triển thuộc danh mục nhóm công tác tương ứng, cũng như biết lộ trình phù hợp để dẫn dắt nhiều hoạt động nghiên cứu và phát triển theo các hạng mục tương ứng. Tuy nhiên, quy trình cho người mới tham gia và cộng tác viên hiện tại có thể chưa được biết cách tham gia hoặc hướng đi đúng hướng cho các công việc tương ứng.

Do đó, những nội dung trong cộng đồng CHAOSS không được chuẩn hoá. Do đó, để nắm được quy trình phù hợp và những nguyên tắc cơ bản về văn hoá làm việc trong 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 của thông tin đó trong dự án CHAOSS. Phần thông tin tối quan trọng và tiêu chuẩn hoá tập trung chủ yếu vào các quy trình mà CHAOSS sử dụng để các CHAOSS có được sự thống nhất về cách hoạt động của cộng đồng, Cách người mới tham gia có thể tham gia và tuân thủ 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 tham gia hoặc thành viên hiện tại phải tuân theo để được tuyển dụng vị trí lãnh đạo trong cộng đồng CHAOSS.

Sổ tay này chính là cẩm nang hướng dẫn cho các thành viên hiện tại và thành viên mới trong 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 hợp phần sáng tạo trong việc thu thập và sắp xếp nội dung cho sổ tay cũng như thành phần kỹ thuật để xác định cách trình bày sổ tay.

NHU CẦU CẦN LÀM GÌ?

Sổ tay cộng đồng là một tài liệu nêu rõ 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à hoạt động của cộng đồng.

Sổ tay này cung cấp phần giới thiệu và cách thức 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ó sẵn trên kho lưu trữ GitHub và cần được cải tiến cũng như tái cấu trúc để bổ sung thêm thông tin cho người mới tham gia và người dùng cộng đồng hiện tại. Vì vậy, cuốn sổ tay dành cho toàn cộng đồng của CHAOSS này sẽ giúp những người mới tham gia và các thành viên hiện tại của cộng đồng theo những cách sau:

  • Chuẩn bị và sắp xếp các chính sách của cộng đồng CHAOSS một cách chuyên nghiệp, tập hợp tất cả ở cùng một nơi
  • Truyền đạt về phần Giới thiệu, Sứ mệnh, Tầm nhìn và khả năng lãnh đạo của cộng đồng
  • Tìm hiểu cách hoạt động của cộng đồng CHAOSS
  • Nguyên tắc đóng góp
  • Xác định quy trình làm việc của dự án
  • Giới thiệu sơ lược 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 cộng đồng sẽ được chia thành nhiều “phần” chứa thông tin phù hợp và chi tiết theo từng chủ đề. Các phần này có thể được chia theo các cách sau:

  • Giới thiệu
  • Cách cộng đồng CHAOSS
  • Lộ trình trở thành người 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 cuộc họp
  • Câu hỏi thường gặp chung
  • Chương trình cố vấn
    • Mùa hè lập trình của Google
    • Sự liên hệ
    • Phần Google Tài liệu

CHI TIẾT VỀ VIỆC CÓ THỂ THAY ĐỔI CHO DỰ ÁN

1.) Giới thiệu:

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

A.) Thư chào mừng sẽ có nội dung chào mừng, cùng với nội dung mô tả ngắn gọn về Cộng đồng CHAOSS, qua đó thuyết phục độc giả truy cập Sổ tay. Tôi cũng sẽ đính kèm Ảnh ghép lấy tại https://chaoss.community/chaoss-photo-album/ để làm nổi bật các phong trào khác nhau trong cộng đồng. B.) Trang này cũng sẽ chứa thông tin chi tiết về tất cả các phần, trong đó có 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ổ tay: Cách sử dụng Sổ tay đã có ở đây( shorturl.at/cqua6 ) nhưng tôi sẽ cải tiến và cải tiến cách sử dụng Sổ tay hiện tại với nhãn hiệu tốt hơn, trong đó bao gồm cả Quy trình sử dụng Sổ tay(Tôi sẽ nêu rõ cách mọi việc diễn ra khi có người muốn thêm, xoá hoặc thảo luận về những nội dung liên quan đến sổ tay). Nó có thể tiếp nối quy trình liên lạc cho bất kỳ vấn đề nào liên quan đến sổ tay.), Hướng dẫn về Sổ tay(bao gồm cách sử dụng trong cộng đồng và phạm vi), Nội dung đóng góp cho Sổ tay ( bao gồm cách người dùng sử dụng kho lưu trữ để thay đổi, thực hiện PR, Mẫu để tuân theo khi thay đổi Sổ tay và Hướng dẫn về văn phong) và Chia sẻ phản hồi về Sổ tay. Trong phần Chia sẻ phản hồi, tôi sẽ đưa vào một mẫu và các cách khác mà người dùng có thể theo dõi nhằm cung cấp hoặc sử dụng các vấn đề trên GitLab để nhận được phản hồi.

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

Cách thức cộng đồng CHAOSS sẽ rất quan trọng để mọi người hiểu được các phương pháp và nguyên tắc cộng đồng. Quy trình công việc có thể giúp nội dung trở nên nổi bật hơn và phác thảo các phương pháp hay nhất dành cho cộng đồng. Mục này bao gồm những nội dung sau:

A.) Giá trị chung: Nêu rõ cách xử lý các vấn đề phát triển bền vững, cởi mở và minh bạch trong Cộng đồng CHAOSS. Tôi sẽ giải thích 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 đến khi làm việc với cộng đồng. B.) Nguyên tắc cộng đồng: Bao gồm cách thực sự tham gia Cộng đồng CHAOSS và tuân theo các điều khoản cơ bản. Phần này cũng sẽ giải thích về văn hoá làm việc bên trong cộng đồng. (Những việc nên làm và việc không nên làm). Tài liệu này sẽ bao gồm danh sách kiểm tra cho cộng tác viên/nhà bảo trì cốt lõi, đồng thời giúp những người khác biết họ nên làm việc với nhà bảo trì như thế nào và danh sách kiểm tra của họ là gì. C.) Nhóm hoạt động: Trang này( https://chaoss.community/participate/ ) chứa thông tin về các Nhóm hoạt động như Mô tả về WG, đường liên kết Repo và thông tin về cuộc họp. Tuy nhiên, trong sổ tay, tôi sẽ trình bày cách tham gia các nhóm làm việc khác nhau và tìm hiểu quy trình đánh giá các chỉ số, tìm hiểu văn hoá làm việc của WG tương ứng và cách trở thành cộng tác viên chính của các nhóm làm việc khác nhau.

3.) Lộ trình trở thành người lãnh đạo:

Mặc dù việc giành lãnh đạo trong một dự án nguồn mở có thể rất quan trọng đối với thành công của chính cộng đồng trong thế giới thương mại. Vì vậy, tôi sẽ đưa ra các nội dung sau đây:

A.) Ban lãnh đạo về kỹ thuật: Bao gồm các quy trình và trách nhiệm đối với Nhà bảo trì Repo, Người viết tài liệu và Nhà duy trì trang web B.) Ban lãnh đạo quản trị: sẽ 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.) Ban lãnh đạo hoạt động: Chương trình này sẽ cung cấp lộ trình cho Quản trị viên diễn đàn

4.) Thuật ngữ:

Thuật ngữ giúp mô tả các thuật ngữ và thành phần tương ứng được sử dụng thường xuyên trong cộng đồng CHAOSS. Ngoài ra, tôi cũng sẽ bao gồm các nguyên tắc sử dụng Thuật ngữ như Viết hoa, Từ viết tắt và Các từ cần tránh kèm theo lý do. Các thuật ngữ có thể bao gồm: Dự án CHAOSS, Sức khoẻ cộng đồng nguồn mở, Đánh giá mã, Nhóm công tác, Chỉ số phần mềm nguồn mở, Chỉ số chung, Tính đa dạng và Chỉ số bao gồm, Nhóm làm việc tiến triển, Nhóm làm việc rủi ro, Nhóm làm việc dựa trên giá trị, Phát hành chỉ số, Khu vực tập trung.

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

Đây là bối cảnh chính cho 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 sự đóng góp hoặc hoạt động tình nguyện của người khác. Vì vậy, điều này sẽ giúp bất kỳ người dùng/người dùng mới tham gia cộng đồng nào hiểu được sự cần thiết và nguyên tắc cơ bản mà họ phải tuân theo. Vì vậy, dữ liệu này sẽ bao gồm các thông tin sau:

A.) Tìm hiểu lộ trình của cộng đồng: Chủ đề này sẽ giúp người dùng nắm được lộ trình của cộng đồng CHAOSS, qua đó giúp người dùng biết nên ưu tiên thực hiện những hoạt động nào trong Dự án CHAOSS. B.) Giải thích những thứ 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.) Giới thiệu tổng quan ngắn gọn về hoạt động của GitLab D.) Hướng dẫn cho người đánh giá/người bảo trì

Phần này cũng sẽ bao gồm “Vai trò và trách nhiệm” đối với từng danh mục Đóng góp như sau:

a.) DESIGN: Tiểu mục này sẽ bao gồm "Quy trình công việc thiết kế CHAOSS" và Nguyên tắc thiết kế bao gồm các Nguyên tắc thiết kế, Quy trình và Công cụ được sử dụng mà người đóng góp phải tuân thủ trong quá trình đó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 về đóng góp vào cơ sở mã. Tài liệu này sẽ bao gồm các Yêu cầu về kỹ thuật, Cấu trúc dự án, Thiết lập dự án(Augur, Cregit, GremoireLab) c.) TÀI LIỆU: Phần này sẽ bao gồm tài liệu cho tài liệu, bao gồm các công cụ và Hướng dẫn về văn phong. d.) TIẾP CẬN: Nội dung bao gồm cách cộng tác viên có thể hỗ trợ cộng đồng CHAOSS trong việc mở rộng sự phát triể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 buổi gặp mặt và sự kiện

6.) Chỉ số

Hiện tại, trang web cộng đồng CHAOSS chứa thông tin về các Phiên bản số liệu( https://chaoss.community/metrics/ ) và điều quan trọng hơn là mọi người phải hiểu cách tuân thủ quy trình để làm cho trang web về số liệu của họ có sẵn trê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 hoạt động để có thể phát hành chỉ số của riêng mình.

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ẽ có ý nghĩa hơn khi bổ sung chi tiết và thông tin giải thích quy trình và quản lý cách thức cho CHAOSScon trong Sổ tay. Trong Sổ tay có các Thông tin sau:

A.) Thông tin chi tiết về Ban tổ chức: Tài liệu này sẽ giải thích các quy trình tham gia vào ban tổ chức của CHAOSScon B.) Quản lý quy trình kêu gọi đề xuất: Phần này 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à xuất bản 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ý các Đề xuất tài trợ và quỹ tài trợ (bao gồm cả gói)

8.) Chương trình ghi hình 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 một số thông tin chi tiết bổ sung 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:

Phần này sẽ chứa tất cả video cuộc họp cùng với nội dung mô tả 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 phần này chứa những câu hỏi chung thường được hỏi trong cộng đồng, đồng thời sẽ giúp những người mới tham gia và các thành viên hiện tại của cộng đồng trả lời được một vài câu hỏi trong số đó.

11.) Mùa hè lập trình của Google:

Phần này sẽ có thông tin về Mùa hè lập trình của Google, Tiêu chí để hội đủ điều kiện, cũng như thông tin về cách mọi người có thể tham gia cộng đồng CHAOSS trong Mùa hè lập trình của Google. Phần này cũng sẽ chứa Mẫu đề xuất mà mọi người có thể sử dụng để dự thảo đề xuất cũng như vai trò và trách nhiệm của họ. Hơn nữa, mục này cũng chứa thông tin giúp các thành viên hiện tại trong cộng đồng tìm hiểu quá trình trở thành quản trị viên tổ chức và cố vấn.

  1. Tư vấn:

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

  1. Phần Google Tài liệu:

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

KẾT QUẢ ƯỚC TÍNH CỦA DỰ ÁN:

Sổ tay đóng vai trò quan trọng trong bất kỳ cộng đồng nào. Tương tự, sổ tay dành cho toàn cộng đồng CHAOSS này sẽ giúp xây dựng tài liệu chi tiết và ngăn nắp hơn cho cộng đồng CHAOSS. Tất cả những 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 thức hoạt động của cộng đồng CHAOSS. Hơn nữa, cuốn sổ tay này sẽ giúp xây dựng những quy trình và con đường đa dạng về văn hoá làm việc trong cộng đồng CHAOSS.

CHI TIẾT KỸ THUẬT:

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

  • WYSIWYG: Trình chỉnh sửa văn bản mạnh mẽ và đẹp mắt
  • Markdown: Khả năng hỗ trợ hiệu quả và mạnh mẽ cho các phím tắt trong Markdown
  • Nhúng nhiều định dạng: Nhúng nội dung web bên ngoài như video, đoạn mã, bài viết, nhạc, v.v.
  • Trang tổng quan dành cho Tác giả: Có một trang tổng quan thông minh dành cho các tác giả hỗ trợ việc chỉnh sửa hình ảnh
  • Bản nháp: soạn những thay đổi mới và cộng tác không đồng bộ
  • Nhận xét về 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 lại và huỷ bỏ nội dung thay đổi
  • Thông tin chi tiết: Ứng dụng này cũng hỗ trợ thông tin chi tiết theo dõi lưu lượng truy cập, điểm xếp hạng và chất lượng nội dung
  • Đồng bộ hoá GitHub: 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 cái nhìn tổng quan 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 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 này trên miền tuỳ chỉnh, thì cộng đồng sẽ hiển thị như sau docs.chaoss.community. Tổ chức chỉ bắt buộc phải 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 chúng tôi với HTTPS được bật theo mặc định. Chứng chỉ doLetEncrypt phát hành

Các miền có thể hỗ trợ:

  • Miền phụ: 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ể thực hiện việc chỉnh sửa trên cả hai nền tảng một cách hiệu quả?

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

Thiết lập chế độ tích hợp GitHub:

  • Từ không gian của bạn trong nền tảng GitBook, hãy nhấp vào thẻ tích hợp > GitHub
  • Cho phép 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
  • Truy cập vào kho lưu trữ GitHub của tổ chức của bạn rồi tạo kho lưu trữ cho “Sách tay” (ví dụ: chaoss-handbook)
  • Bây giờ, hãy chọn kho lưu trữ có tên chaoss-sổ tay 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ữ sổ tay hỗn loạn, cho phép tìm nạp nội dung về mọi thay đổi đối với kho lưu trữ. Khi thực hiện thay đổi đối với GitBook, một nhận xét mới sẽ được đẩy lên.

Vậy là xong! Ai cũng có thể tiếp tục chỉnh sửa trong kho lưu trữ GitHub hoặc GitHub.

-- Làm cách nào để chỉnh sửa các trang trên nền tảng GitBook?

Bất kỳ ai muốn chỉnh sửa bất kỳ 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 liên kết tham gia. GitBook hỗ trợ tính năng chỉnh sửa trực quan, nơi người dùng có thể viết trực tiếp trong các trang.

Bản nháp là phiên bản có thể chỉnh sửa của nội dung người dùng mà chỉ người viết mới có thể truy cập và được tạo tự động sau 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 hình ảnh lên, v.v.).

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

Không phải lúc nào phiên bản đầu tiên của bản nháp cũng sẵn sàng xuất bản ngay. Sử dụng ""lưu"" khi bạn muốn tiếp tục công việc của mình sau này 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 thay đổi bạn thực hiện sẽ được cung cấp cho các thành viên trong nhóm của bạn và/hoặc được 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 chỗ có thể chứa số trang bạn cần để viết tài liệu. Tất cả những trang này đều xuất hiện ở phía bên trái màn hình của bạn trong mục chúng tôi gọi là Mục lục. Trên Mục lục, bạn có thể quản lý các trang của mình: tạo trang mới, nhóm trang, thêm liên kết 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 đầu tiên: Trang đầu là trang chủ hoặc gốc của tài liệu và về cơ bản đóng vai trò là trang chủ của tất cả các trang trong tài liệu của bạn. Vì đây là lối vào 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á trang, tạo mục con hoặc tạo trang trong một nhóm.

Trang: Một trang có tiêu đề, 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 nội dung đó.Bạn có thể lồng các trang bằng cách kéo và thả một trang xuống dưới một trang khác. Các phần tử con của trang sẽ bị ẩn nhưng có thể thu gọn được.

Liên kết ngoài: Các mục nhập này là liên kết ngoài và không có bất kỳ nội dung nào trong trình chỉnh sửa. Chức năng chính của chúng là liên kết tới 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 khi ghi lại nhiều phiên bản của API, thư viện hoặc bản dịch.

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

-- Sổ tay sẽ được trình bày như thế nào ở phía máy khách?

Người dùng sẽ có thể truy cập vào sổ tay cộng đồng Chaoss thông qua miền con (https://docs.chaoss.community) và phiên bản này sẽ có cấu trúc như sau:

  • Sổ tay Mattermost – https://handbook.Themost.com/
  • Tài liệu cầu nối cộng đồng 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 khác nhau trong dự án, đặt câu hỏi làm rõ cho cộng đồng
  • Làm rõ với cộng đồng để biết nên sử dụng nền tảng nào cho sổ tay (tôi đề xuất GitBook) và thiết lập
  • Đóng góp vào 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 (từ 14/9 — 20/9)

  • Bản nháp”

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

  • Bản nháp phần "The CHAOSS Community Way"

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

  • Soạn thảo phần "Lộ trình lãnh đạo"
  • Soạn thảo mục "Thuật ngữ"

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

  • Soạn thảo lộ trình phát triển cộng đồng
  • Nguyên tắc về nội dung đóng góp cho thiết kế ở dạng bản 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 cho mục Viết và liên hệ

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

  • Mục Chỉ số dự thảo
  • Mục CHAOSScon nháp

H.) Tuần 12 (2/11 – 8/11)

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

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

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

  • Bản nháp 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 liên hệ

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

  • Thời gian giữa các khung giờ nhận đặt lịch hẹn; Tinh chỉnh và cải thiện toàn bộ tài liệu

3.) Giai đoạn đánh giá (ngày 30/11 — 5/12)

A.) Tuần 16:

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

TƯƠNG TÁC VỚI CỘNG ĐỒNG

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

Tôi đã lướt sóng trong 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 những cố vấn cụ thể cho dự án của tôi( Georg Link và Armstrong Foundjem). Một trong những nội dung thảo luận thu hút 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ể được tìm thấy trên chuỗi danh sách gửi thư lưu trữ của CHAOSS với 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 của cộng đồng, qua đó giúp tôi cập nhật thông tin cho cộng đồng.

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

Vì dự án này đòi hỏi việc thiết lập sổ tay cho toàn cộng đồng, do đó, những thông tin mà mọi người phải truy cập trong dự án này sẽ được thu thập và thảo luận với các thành viên trong cộng đồng. Như tôi đã đề xuất lịch trình ở trên, theo đó tôi có thể thảo luận và thu thập thông tin cần thiết trong khoảng thời gian gắn kết cộng đồng.

Tôi sẽ nghiên cứu về các phần khác nhau theo CHAOSS và duy trì các chuỗi bài đăng trên danh sách gửi thư. Tuỳ vào yêu cầu, tôi sẽ cố gắng đặt câu hỏi làm rõ từ người cố vấn và cộng đồng.

Để có những 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 nghĩ mình sẽ làm gì để thông báo cho cộng đồng về tiến độ của mình và mọi vấn đề hoặc câu hỏi mà các bạn có thể đặt ra trong suốt quá trình thực hiện dự án?

Để có sự linh hoạt và tính minh bạch, tôi sẽ cố gắng trao đổi thông qua thảo luận về danh sách gửi thư để hỏi xem tôi có những thắc mắc nào.

Tôi sẽ chia sẻ tiến độ hằng tuần của mình dưới dạng một bài đăng trên blog, trong đó bao gồm các tài liệu scrum và các thử thách mà tôi phải đối mặt. Những tài liệu 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 gia các cuộc gọi cộng đồng hằng tuần để đưa ra đề xuất và thảo luận phù hợp về các vấn đề chính.

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

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

Tôi tin rằng vai trò của người cố vấn là dẫn dắt học sinh đi đúng hướng và không phải giải thích từng góc lặp cho học sinh. Trách nhiệm duy nhất của học viên là trách nhiệm nghiên cứu và triển khai dự án. Xin lưu ý rằng tôi sẽ chỉ cố gắng yêu cầu trợ giúp từ người cố vấn khi không còn cách nào khác.

Tuy nhiên, nếu cố vấn không có mặt/bận 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 đang gặp phải trong cộng đồng CHAOSS. Tôi chắc chắn rằng ai đó có thể giúp tôi giải quyết bất kỳ khó khăn nào 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/cộng đồng nhà phát triển trực tuyến như dev.to

Hơn nữa, tôi cũng sẽ thử tham gia mọi cuộc gọi hằng tuần để được trợ giúp trong cộng đồng CHAOSS để đặt ra những câu hỏi của mình.