Genel Bakış
Bu kılavuzda, kendi Google Earth Engine eğitimlerinizi yazmayla ilgili genel yönergeler verilmektedir. Bu kılavuzun amacı, tüm Earth Engine topluluğu tarafından kolayca anlaşılabilen, net ve kısa, yüksek kaliteli eğitimler oluşturmayı kolaylaştırmaktır.
Aşağıdaki eğitim şablonları, kendi eğitimlerinizi oluşturmaya başlamanıza yardımcı olacak ek bir kılavuz olarak da kullanılabilir. Başlamak için şablonların nasıl kullanılacağıyla ilgili ayrıntıları Eğitim Yazma bölümünde bulabilirsiniz.
Ayrıca Google Cloud Topluluğu Eğitim Stil Kılavuzu, geniş bir kitle için uçtan uca eğitimler yazma konusunda değerli bir referans sağlar. Google JavaScript Stil Kılavuzu ise JavaScript kod örneklerinde kullanılması önerilen stili ayrıntılı olarak açıklar. İnceleme uzmanları, gönderiminizi incelerken bu kılavuzlardan yararlanabilir.
Genel yönergeler
- Kısa ve öz olun.
- Kendinizi tekrarlamayın.
- Aynı şeyi iki kez söylemeyin (farklı şekilde ifade edilmiş olsa bile).
- İlerleme durumunu düzenli olarak işaretleyin.
- Eğitimin önemli noktalarına resim ve metin ekleyerek kullanıcının doğru yolda olduğunu bilmesini sağlayın. Bu seçeneği yalnızca eminseniz kullanın.
- Mümkün olduğunda etken çatı kullanın.
- "Değer değiştiğinde" değil, "Kullanıcı değeri değiştirdiğinde".
- İstisna: Etken yapı kullanmak için çok uğraşmanız gerekiyorsa veya eylemi gerçekleştiren kişi belliyse ya da alakalı değilse edilgen yapı kullanabilirsiniz ("Earth Engine, animasyonlu bir GIF döndürür" yerine "animasyonlu bir GIF döndürülür").
- Gerçeklere bağlı kalın.
- Abartılı ifadelerden kaçının ("Bu, %100 en iyi ve en hızlı yöntemdir").
- Ürün veya hizmetleri tanıtmaktan kaçının.
- Tartışmalı konulardan kaçının.
- Belirli yöntemlere, veri kümelerine ve analizlere atıfta bulunurken alıntıları ve URL'leri ekleyin.
- Eğitici videonuz bağımsız olmalıdır.
- API dışındaki özel kitaplıklara veya herkese açık Earth Engine Veri Kataloğu'nda yer almayan veri kümelerine güvenmeyin.
- Ek veri veya algoritma sağlıyorsanız bunları yalnızca izniniz varsa paylaşın. Gerekli tüm lisansları ve atıfları ekleyin.
- Kodunuzu test edin.
- Makalenizi incelemeye göndermeden hemen önce, eklediğiniz tüm kod örneklerini çalıştırıp test ettiğinizden emin olun.
Eğitim dosyası üstbilgileri
Eğitim Yazma bölümünde sağlanan şablonları kullanmadan topluluk eğitimlerini manuel olarak oluşturup gönderiyorsanız dosyanın başına uygun meta verileri ve lisans başlığını manuel olarak eklemeniz gerekir. Kendi eğitiminizde kullanabileceğiniz bir şablonu görüntülemek için istediğiniz biçimi seçin:
Markdown
Dokümanın başına aşağıdakileri ekleyin. Üstbilgiden önce boşluk veya başka karakterler bulunmamalıdır:
---
title: Your tutorial title
description: A short description of the tutorial, all on one line with no carriage returns.
author: your-github-username
tags: comma-separated, lowercase, list, of, related, keywords
date_published: YYYY-MM-DD
---
<!--
Copyright 2023 The Google Earth Engine Community Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
Eğitiminizi incelemeye göndermeden önce uygun şablon alanlarını değiştirdiğinizden emin olun.
Colab
Not defterinin başındaki bir kod hücresine aşağıdakileri ekleyin:
#@title Copyright 2023 The Earth Engine Community Authors { display-mode: "form" }
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
Eğitim şablonları
Markdown
Git ve GitHub hakkında bilgi sahibiyseniz aşağıdaki kodu şablon olarak kullanabilirsiniz:
---
title: Your tutorial title
description: A short description of the tutorial, all on one line with no carriage returns.
author: your-github-username
tags: comma-separated, lowercase, list, of, related, keywords
date_published: YYYY-MM-DD
---
<!--
Copyright 2023 The Google Earth Engine Community Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
In a few sentences, describe what the user is going to learn. Be sure to include
_concise_ background information; only include what's helpful and relevant.
When in doubt, leave it out!
## Section heading 1
Break up your tutorial into manageable sections.
With one or more paragraphs, separated by a blank line.
Inside your sections, you can also:
1. Use numbered lists
1. ..when the order..
1. ..of items is important.
And:
- This is a bulleted list.
- Use bulleted lists when items are not strictly ordered.
..and even:
Use | tables | to organize | content
------- | -------- | ----------- | -------
Your | tables | can | also
contain | multiple | rows | ...
## Section heading 2
Use separate sections for related, but discrete, groups of steps.
Use code blocks to show users how to do something after describing it:
```js
// Use comments to describe details that can't be easily expressed in code.
// Always try making code more self descriptive before adding a comment.
// Similarly, avoid repeating verbatim what's already said in code
// (e.g., "assign ImageCollection to variable 'coll'").
var coll = ee.ImageCollection('LANDSAT/LC08/C02/T1_TOA');
```
### Use subsections if appropriate
Consider breaking longer sections that cover multiple topics or span multiple
pages into subsections.
Alternatif olarak, yukarıdaki şablon Eğitim Yazma bölümündeki talimatlar uygulanarak doğrudan GitHub'ın web tabanlı dosya düzenleyicisinde açılabilir.
Eğitim önerme, yazma ve gönderme ile ilgili önemli ayrıntılar için Eğitim Yazma bölümüne bakın.
Colab
Önerilen stil şablonunu kullanarak yeni bir Colab not defteri oluşturmak için burayı tıklayın:
Bu işlem, eğitim içeriğinizi yazma ve gönderme talimatlarını içeren bir not defteri açar. Teklif, yazma ve gönderme süreciyle ilgili önemli ayrıntılar için Eğitim Yazma bölümüne göz atın.