Viết hướng dẫn đầu tiên cho cộng đồng

Không gian này dành cho những người dùng Earth Engine muốn chia sẻ kiến thức của mình với cộng đồng Earth Engine. Được tạo bởi người dùng Earth Engine, dành cho người dùng Earth Engine, các hướng dẫn trong phần này dành cho mọi cấp độ, từ người mới bắt đầu đến người dùng có trình độ cao hơn.

Bạn có thể gửi hướng dẫn dưới dạng văn bản thuần tuý và mã được định dạng bằng ngôn ngữ đánh dấu Markdown hoặc dưới dạng sổ tay Colab có chứa Markdown và mã Python có thể thực thi. Các hướng dẫn được xây dựng bằng thư viện ứng dụng JavaScript của Earth Engine thường được viết bằng Markdown, trong khi Colab được đề xuất cho các hướng dẫn dựa trên thư viện ứng dụng Python của Earth Engine.

Trước khi bắt đầu

Bộ quy tắc ứng xử

Nhóm Earth Engine cam kết xây dựng một cộng đồng hoà nhập và không có hành vi quấy rối. Vui lòng tìm hiểu Quy tắc ứng xử của chúng tôi trước khi đóng góp.

Tham gia GitHub

Các hướng dẫn của cộng đồng Earth Engine được chia sẻ và xem xét thông qua GitHub. Nếu chưa có tài khoản GitHub, trước tiên bạn phải tạo một tài khoản tại https://github.com/join.

Đề xuất hướng dẫn

Trước khi đầu tư nhiều thời gian và công sức vào một hướng dẫn mới, các cộng tác viên tiềm năng được yêu cầu gửi một đề xuất đơn giản kèm theo một số thông tin cơ bản. Điều này cho phép tác giả làm việc với người duy trì tài liệu dành cho nhà phát triển Earth Engine để tập trung vào những hướng dẫn mang lại nhiều giá trị nhất cho cộng đồng người dùng Earth Engine. Việc này cũng giúp tiết kiệm thời gian bằng cách tránh trường hợp trao đổi qua lại trong quá trình xem xét.

Đề xuất một hướng dẫn

Thiết lập lần đầu

Nếu đây là lần đầu tiên bạn gửi một hướng dẫn đến kho lưu trữ GitHub của cộng đồng Earth Engine, hãy nhớ hoàn tất các bước sau trước khi bắt đầu thực hiện hướng dẫn:

  1. Chấp nhận Thoả thuận cấp phép dành cho người đóng góp (CLA) tại:

    https://cla.developers.google.com

  2. Đọc và nắm vững Hướng dẫn về phong cách viết hướng dẫn cộng đồng.

Viết và gửi hướng dẫn

Sau khi đề xuất hướng dẫn của bạn được người duy trì chấp nhận, bạn có thể chỉnh sửa hướng dẫn và gửi hướng dẫn đó đến kho lưu trữ cộng đồng Earth Engine theo một số cách:

Hướng dẫn nhanh về Markdown

Bạn có thể phân nhánh kho lưu trữ GitHub và tạo một hướng dẫn mới ngay thông qua trang web GitHub để nhanh chóng bắt đầu mà không cần thêm công cụ hoặc thiết lập:

  1. Nếu bạn chưa đăng nhập, hãy đăng nhập vào GitHub.

  2. Để tạo và chỉnh sửa một tệp hướng dẫn mới, hãy nhấp vào Hướng dẫn mới. Bạn sẽ được nhắc phân nhánh kho lưu trữ nếu cần.

    Hướng dẫn mới

  3. Nhập tên cho tệp hướng dẫn của biểu mẫu:

    your-tutorial-name/index.md

    Trong đó, your-tutorial-name là tên ngắn của hướng dẫn, được viết thường. Dùng dấu gạch ngang ("-") để phân tách các từ. Không sử dụng dấu cách hoặc bất kỳ dấu câu nào khác trong tên thư mục.

  4. Chỉnh sửa hướng dẫn ngay trong trình chỉnh sửa tệp trên GitHub bằng cách sử dụng "Xem trước" để xác minh đầu ra được định dạng (xem thêm phần Chỉnh sửa tệp trong kho lưu trữ trong tài liệu của GitHub).

  5. Khi đã sẵn sàng, hãy xác nhận các thay đổi và mở một yêu cầu kéo.

Sổ tay Colab

Nhấp vào đây để bắt đầu viết hướng dẫn trong Colab:

Hướng dẫn mới về Colab

Thao tác này sẽ mở một sổ tay có hướng dẫn về cách tạo và gửi hướng dẫn.

Nâng cao

Nếu bạn đã quen thuộc với GitHub, git và các công cụ liên quan, thì quy trình tổng thể để gửi cả hướng dẫn bằng Markdown và Colab đều giống nhau:

  1. Phân nhánh và sao chép kho lưu trữ google/earthengine-community trên GitHub.

  2. Tạo một thư mục trong tutorials có tên ngắn đã được chuyển đổi thành chuỗi nhận dạng của hướng dẫn (ví dụ: tutorials/my-amazing-tutorial).

  3. Thêm tiêu đề thích hợp cho Markdown hoặc Colab.

  4. Chuyển hướng dẫn đến thư mục mới bằng tên tệp index.md (đối với Markdown) hoặc tutorial.ipynb (đối với Colab). Chuyển các hình ảnh được dùng trong hướng dẫn vào cùng một thư mục.

  5. Đẩy nội dung mới vào nhánh của bạn và mở một yêu cầu kéo.

Khi tạo yêu cầu kéo, hãy nhớ tham khảo đề xuất ban đầu theo mã số sự cố trên GitHub trong phần bình luận. Ví dụ: nếu vấn đề là #123, bạn sẽ đặt văn bản "Closes #123" vào phần mô tả yêu cầu kéo để tham chiếu đề xuất ban đầu và tự động đánh dấu đề xuất đó là đã hoàn tất sau khi hướng dẫn được xuất bản.

Sau khi bạn mở một yêu cầu kéo, một hoặc nhiều người duy trì sẽ được chỉ định để xem xét nội dung bạn gửi. (Các) người đánh giá sẽ làm việc với bạn để đảm bảo thông tin bạn gửi là đầy đủ, chính xác và nhất quán với Hướng dẫn về phong cách viết hướng dẫn cho cộng đồng Earth Engine.

Sau khi yêu cầu kéo của bạn được phê duyệt, hướng dẫn của bạn sẽ được nhà duy trì kho lưu trữ xuất bản.