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 Phần Google 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 gian tiêu chuẩn (3 tháng)

Mô tả dự án

TÓM TẮT VỀ DỰ ÁN:

Hiện tại, các nhóm làm việc trong cộng đồng CHAOSS đã phát triển những phương thức làm việc riêng và ghi lại các quy trình khác nhau của họ ở nhiều mức độ khác nhau. Các nhóm làm việc bao gồm các nhóm chỉ số chung: WG, Sự đa dạng và hoà nhập, Phát triển, Rủi ro và Giá trị. Các nhóm này đã thiết lập phương thức tham gia và làm việc của riêng mình, cũng như điều chỉnh văn hoá làm việc và giao tiếp theo nhiều cách. Các nhóm làm việc theo chỉ số này có các lĩnh vực trọng tâm và nền tảng hoạt động dựa trên các chỉ số phù hợp, dẫn dắt nhiều nhóm nghiên cứu và phát triển thuộc hạng mục nhóm làm việc tương ứng, 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 biết cách tham gia hoặc đưa ra lộ trình đúng đắn cho các hoạt động tương ứng.

Do đó, những vấn đề 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 những 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à tiêu chuẩn hoá tập trung chủ yếu vào những quy trình mà CHAOSS sử dụng để CHAOSS đạt được sự thống nhất về cách làm việc của cộng đồng, Cách những 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 thực hiện để bổ nhiệm chức năng lãnh đạo trong cộng đồng CHAOSS.

Sổ tay này chính là tài liệu hướng dẫn cho các thành viên mới và hiện tạ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 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.

NHỮNG YẾU TỐ NÀO?

Sổ tay cộng đồng là một 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à hoạt động của cộng đồng.

Sổ tay này cung cấp phần giới thiệu và hoạt động rõ ràng cho các thành viên mới tham gia của 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 hiện tại của cộng đồng. Vì vậy, cuốn sổ tay này dùng cho toàn cộng đồng của CHAOSS sẽ giúp 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 hoá và sắp xếp các chính sách của cộng đồng CHAOSS để tất cả ở cùng một nơi
  • Truyền đạt 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 thức 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 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 “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
  • Cách 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 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 tài liệu trên Google

CÁC YẾU TỐ CÓ THỂ DÙNG CHO DỰ ÁN CHI TIẾT

1.) Giới thiệu:

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

A.) Trong đó có Tin nhắn chào mừng cùng nội dung mô tả ngắn gọn về Cộng đồng CHAOSS để thuyết phục độc giả truy cập Sổ tay. Tôi cũng sẽ gửi kèm Ảnh ghép lấy từ đây https://chaoss.community/chaoss-photo-album/ để nêu 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 mỗi phần và các đường liên kết thích hợp. C.) Cách sử dụng Sổ tay: Hiện đã có cách sử dụng Sổ tay tại đây( shorturl.at/cpcQU6 ) nhưng tôi sẽ cải tiến và tái cấu trúc cách sử dụng Sổ tay hiện tại với Markdown tốt hơn, trong đó có Quy trình sử dụng Sổ tay(Tôi sẽ thêm nội dung về cách diễn ra khi ai đó muốn thêm, xoá hoặc thảo luận những thứ liên quan đến sổ tay). Có thể việc này sẽ tiếp nối quy trình trao đổi thông tin cho mọi vấn đề liên quan đến sổ tay.), Nguyên tắc Sổ tay(bao gồm cách sử dụng trong cộng đồng và phạm vi), Đóng góp vào sổ tay ( bao gồm cách sử dụng kho lưu trữ để thay đổi, giới thiệu quan hệ công chúng, Mẫu cần thực hiện để thay đổi Sổ tay và Hướng dẫn về phong cách) và Chia sẻ ý kiến phản hồi về Sổ tay. Trong phần Chia sẻ ý kiến phản hồi, tôi sẽ bao gồm một mẫu và nhiều cách mà người dùng có thể làm theo để cung cấp hoặc sử dụng các vấn đề của GitLab để nhận được.

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

Cách cộng đồng CHAOSS sẽ rất quan trọng để mọi người hiểu rõ các nguyên tắc và cách thức hoạt động của cộng đồng. Quy trình công việc có thể khiến công việc được nhấn mạnh hơn và phác thảo các phương pháp của cộng đồng một cách tốt nhất. 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 vấn đề về tính bền vững, sự cởi mở và tính 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 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. Nội dung này cũng sẽ giải thích văn hoá làm việc mà bạn áp dụng trong cộng đồng. (Những việc nên làm và việc không nên làm). Hướng dẫn này sẽ bao gồm danh sách kiểm tra cho người đóng góp/người bảo trì cốt lõi, cũng như cho những người khác biết họ nên làm việc với những người bảo trì và danh sách kiểm tra của họ như thế nào. 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ư Mô tả về WG, đường liên kết Repo và thông tin cuộc họp nhưng trong sổ tay, tôi sẽ đưa vào đó cách tham gia vào 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 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 cho các nhóm làm việc khác nhau.

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

Tuy việc giành được vị trí lãnh đạo trong một dự án nguồn mở có thể là yếu 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. Do đó, khi cân nhắc đến vấn đề này, tôi sẽ đưa ra những nội dung sau:

A.) Ban lãnh đạo về kỹ thuật: Bao gồm các quy trình và trách nhiệm của Nhà bảo trì kho lưu trữ, Người viết tài liệu và Nhà bảo trì trang web B.) Lãnh đạo quản trị: đây sẽ bao gồm lộ trình chuyển đổi cho Thành viên Hội đồng quản trị và Người ra quyết định C.) Lãnh đạo hoạt động: Phần này sẽ chứa lộ trình dà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à nội dung tương ứng được dùng thường xuyên trong cộng đồng CHAOSS. Hơn nữa, tôi cũng sẽ đưa ra các nguyên tắc sử dụng Thuật ngữ như Viết hoa, Viết tắt và Các từ cần tránh kèm theo lý do. Các điều khoản sẽ được đưa vào bao gồm Dự án CHAOSS, Sức khoẻ cộng đồng nguồn mở, Đánh giá mã, Nhóm làm việ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 hoá, Nhóm làm việc theo rủi ro, Nhóm làm việc về giá trị, 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 cho mọi cộng đồng nguồn mở vì hầu hết cộng đồng nguồn mở phụ thuộc vào sự đóng góp hoặc tình nguyện làm việc. Vì vậy, điều này sẽ giúp bất kỳ người dùng/người dùng mới nào tham gia cộng đồng 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 chi tiết sau:

A.) Tìm hiểu Lộ trình của Cộng đồng: Chủ đề này sẽ dẫn đến một góc nhìn tổng quan về lộ trình của cộng đồng CHAOSS, qua đó giúp người dùng biết được hướng đi hoặc quy trình cần thực hiện, cụ thể là để ưu tiên những hoạt động khác nhau trong Dự án CHAOSS. B.) Giải thích những việc cần thiết để thực hiện bất kỳ nội dung đóng góp nào như phát triển, Tài liệu, Thiết kế, Kiểm thử, 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 bao gồm “Vai trò và trách nhiệm” đối với từng danh mục Đóng góp dưới đây:

a.) DESIGN: Tiểu mục này bao gồm "Quy trình công việc thiết kế CHAOSS" và "Nguyên tắc thiết kế", trong đó có 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: Mục này sẽ chứa hướng dẫn về việc đóng góp vào cơ sở mã. Tài liệu này sẽ chứa 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 về tài liệu, bao gồm cả các công cụ và Hướng dẫn về văn phong. d.) LIÊN HỆ: Nội dung cập nhật bao gồm cách người đóng góp có thể hỗ trợ cộng đồng CHAOSS trong việc tiếp cận cộng đồng 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 gỡ 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 Bản phát hành 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 thực hiện theo quy trình để đưa trang web về số liệu của họ lên trang web đó. Vì vậy, phần này sẽ cung cấp những 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 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 hợp lý hơn khi thêm các chi tiết và thông tin giải thích thông tin giải thích quy trình và quản lý cách thức cho CHAOSScon trong Sổ tay. Sổ tay sẽ có những Thông tin sau:

A.) Thông tin chi tiết về Ban tổ chức: Giải thích quy trình tham gia ban tổ chức của CHAOSScon B.) Quản lý quy trình kêu gọi đề xuất: 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 và khoản tiền tài trợ Bao gồm cả Gói

8.) Chương trình phát sóng CHAOSScast:

Thông tin về CHAOSScast có ở đây https://github.com/chaoss/governance/blob/master/community-handbook/chaosscast.md. Thông tin này sẽ được đưa vào Sổ tay cùng một số thông tin bổ sung như Đơn tham gia, Uỷ 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:

Các câu hỏi này sẽ bao gồm các câu hỏi chung thường gặp trong cộng đồng và sẽ giúp người mới tham gia và thành viên hiện tại trong cộng đồng trả lời một vài câu hỏi.

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í về điều kiện tham gia và 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 các 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 của họ. Hơn nữa, tài liệu này còn cung cấp 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 và người cố vấn của tổ chức.

  1. Liên hệ:

Phần này sẽ có thông tin về Hoạt động tiếp cận, Tiêu chí về điều kiện tham gia và thông tin về cách mọi người có thể tham gia vào cộng đồng CHAOSS (Thúc đẩy các hoạt động trong cộng đồng) tại Conversationy.Phần 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à những người cố vấn.

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

Phần này sẽ có thông tin về GSoD, Tiêu chí về tính đủ điều kiện 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 sẽ bao gồm 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Ả DỰ KIẾN DỰ ÁN:

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

THÔNG TIN KỸ THUẬT:

Tôi dự định sử dụng nền tảng Gitbook để 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: Hỗ trợ các phím tắt trong Markdown một cách hiệu quả và hiệu quả
  • Nhúng đa dạng thức: 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 nhà văn: Có một trang tổng quan thông minh dành cho người viết, hỗ trợ việc chỉnh sửa hình ảnh
  • Bản nháp: soạn các thay đổi mới và cộng tác một cách không đồng bộ
  • Nhận xét về hỗ trợ: Thảo luận và xem lại 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: API 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
  • GitHub Sync: Duy trì quy trình làm việc và đồng bộ hoá tài liệu với GitHub
  • Xây dựng thương hiệu tuỳ chỉnh: 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 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 này sẽ được lưu trữ trên chính GitBook, trong đó 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ì miền đó 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. Để thiết lập miền 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ỉ do CMake mã hoá phát hành

Miền được 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ả?

Khả năng 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 đẩy tới 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 tính năng 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 tài khoản GitHub được liên kết với tổ chức của bạn
  • Truy cập GitHub của tổ chức bạn và tạo một kho lưu trữ cho "Sổ tay" (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ữ sổ tay hỗn độn, cho phép nó 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 gửi.

Xin cảm ơn! Bất cứ ai cũng có thể tiếp tục chỉnh sửa qua kho lưu trữ GitHub hoặc GitBook.

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

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

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

Các thay đổi được thực hiện trên bản nháp là phù hợp với nó, cho phép người dùng đóng góp đồng thời trên cùng một tài liệu với các thành viên khác mà không tạo ra bất kỳ xung đột nào! Đây là những gì chúng tôi 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 để phát hành ngay lập tức. Hãy sử dụng ""lưu"" khi bạn muốn tiếp tục công việc 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 của mình. Sau đó, nội dung bạn viết hoặc những 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 hiển thị 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 tuỳ ý để viết tài liệu. Tất cả những trang này hiển thị ở phía bên trái màn hình của bạn trong mục mà chúng tôi gọi là Mục lục. Từ 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 ban đầu là trang chủ hoặc gốc của tài liệu và về cơ bản có vai trò là trang chủ tất cả các trang trong tài liệu của bạn. Vì đó là lối vào chính của tài liệu và của không gian của bạn, nên bạn không thể di chuyển, xoá, thêm trang này hoặc đặt trang có thành phần con hoặc nằm trong một nhóm.

Trang: 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 mọi loại nội dung vào trang đó.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. Phần tử con của trang sẽ bị ẩn nhưng có thể được thu gọn.

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 đế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 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 ở phía máy khách như thế nào?

Người dùng có thể truy cập sổ tay cộng đồng Chaoss thông qua một miền con có thể là https://docs.chaoss.community. Sổ tay này sẽ có dạng như sau ở phía người dùng:

  • Sổ tay Mattermost – https://handbook.impactmost.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ác câu hỏi làm rõ cho cộng đồng
  • Làm rõ với cộng đồng nền tảng nào nên sử dụng 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 (14/9 – 20/9)

  • Bản nháp”

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

  • Bản nháp "Cách cộng đồng CHAOSS"

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

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

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

  • Phác thảo lộ trình phát triển 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 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 những câu hỏi thường gặp chung về cộng đồng

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

  • Bản nháp về nguyên tắc GSoC

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

  • Bản nháp về Nguyên tắc đối ngoại

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

  • Thời gian lưu vào vùng đệm; Đánh 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 một 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 cùng cộng đồng.

Vâng, tôi đã lướt sóng trong cộng đồng CHAOSS từ tháng 4 năm 2020 và tham gia vào 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 người 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 sự quan tâm 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ư của CHAOSS với tên gọi 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 để giúp cung cấp thông tin cập nhật 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 yêu cầu thiết lập sổ tay toàn cộng đồng nên thông tin phải được truy cập trong dự án sẽ được thu thập và thảo luận với các thành viên cộng đồng. Sau khi đề xuất lịch trình ở trên, tôi có thể thảo luận và thu thập những 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 về các phần khác nhau theo CHAOSS và tiếp tục cập nhật danh sách gửi thư cho các chuỗi thư. Tôi sẽ cố gắng đặt câu hỏi rõ ràng của người cố vấn và cộng đồng tuỳ theo yêu cầu.

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

3.) Bạn đề xuất mình sẽ thông báo cho cộng đồng về tiến độ của mình như thế nào cũng như mọi vấn đề hoặc câu hỏi có thể có trong suốt quá trình thực hiện dự án?

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

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, trong đó bao gồm các tài liệu scrum và các thách thức phải đối mặt. Các tài liệu này sẽ được chia sẻ trong danh sách gửi thư của cộng đồng để tiếp cận nhiều độc giả hơn trong tổ chức mã nguồn mở này.

Tôi cũng sẽ tham gia các cuộc gọi cộng đồng hằng tuần để có các đề xuất và cuộc 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 Trello chứa những nhiệm vụ có sẵn 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 đề cũng như các tính năng đang được áp dụng.

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

Tôi tin rằng vai trò của người 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 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 sẽ chỉ cố gắng tìm kiếm sự 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 người cố vấn không có mặt 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à mình đang gặp phải trong cộng đồng CHAOSS. Tôi chắc rằng ai đó sẽ giúp tôi giải quyết mọi thử thách 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

Ngoài ra, tôi sẽ cố gắng tham gia các cuộc gọi hằng tuần để được trợ giúp trong cộng đồng CHAOSS để đặt ra những nghi ngờ.