İçerik ekleme ve düzenleme

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Drupal'ın "Temel Sayfa" içerik türünü kullanarak API'nizle ilgili "Nasıl Yapılır?" kılavuzları ve API referans belgeleri gibi dokümanları Geliştirici Hizmetleri portalınıza ekleyin ve video, ekran video kaydı veya kod indirme gibi içerikleri dahil edin.

Belgeler sayfası, "Başlarken" ve "Eğiticiler" gibi çeşitli kategorilerde düzenlenmiş bazı başlangıç girişleriyle oluşturulur. Bu sayfa, düzenlemeniz için bir başlangıç noktasıdır. Bu şekilde, kendi içerik girişlerinizi ekleyebilir ve bu girişleri istediğiniz şekilde düzenleyebilirsiniz.

Belgeler ana sayfasını ekleme

Varsayılan olarak Belgeler ana sayfası, geliştirici portalınızdaki <siteURL>/documentation adresinde bulunur. Geliştirici portalının varsayılan ana sayfası, ana sayfanın üst kısmındaki kutuda şu sayfanın bağlantısını içerir:

Ayrıca geliştirici portalı menüsünün ana menüsünde bu sayfaya bir Belgeler bağlantısı da ekleyebilirsiniz.

Ancak Belgeler ana sayfası varsayılan olarak mevcut değildir. Bu nedenle, geliştirici portalında doğru URL'de yeni bir sayfa oluşturmanız gerekir.

Belgeler ana sayfasını geliştirici portalınıza eklemek için:

1. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
2. Drupal yönetim menüsünde İçerik > İçerik ekle > Temel sayfa'yı seçin.
3. Dokümanın başlığını (ör. Belgeler Ana Sayfası) ve ilk sayfanın içeriğini girin.
4. Özet eklemek için Özeti düzenle'yi tıklayın.
5. Gövde bölümünün altındaki Menü ayarları öğesini tıklayın.
6. Menü bağlantısı sağla'yı seçin, bağlantı başlığını ekleyin ve Üst Öğede <Ana menü> öğesini seçin.
   Bu, Dokümanlar ana sayfanızın ana menüsüne bağlantı ekler.
7. Gövde bölümünün altındaki URL yolu ayarları öğesini tıklayın.
8. Otomatik URL takma adı oluştur'un seçimini kaldırın ve dokümanlarda URL takma adını ayarlayın.
   Varsayılan olarak, bir sayfanın URL'si <siteURL>/content/pageName şeklindedir. URL takma adını ayarlayarak sayfanın açık URL'sini ayarlamış olursunuz (bu örnekte, <siteURL>/documentation).
9. Sayfayı kaydedin.
   Artık menü çubuğunda sayfanın bağlantısını görüyor olmalısınız. Ana sayfadaki kutuda yer alan bağlantı artık çalışacaktır.
   Yönetici olarak, Görüntüle ve Düzenle gibi içerik yönetimi düğmelerini de görürsünüz. Yönetici olmayanlar bu bilgileri görmez.

Dokümanlarınıza alt sayfa ekleme

Dokümanlarınıza alt sayfalar ekledikçe:

1. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
2. Drupal yönetim menüsünde İçerik > İçerik ekle > Temel sayfa'yı seçin.
3. Sayfa başlığını ve içeriği girin.
4. Özet eklemek için Özeti düzenle'yi tıklayın.
5. Gövde bölümünün altındaki Menü ayarları öğesini tıklayın.
6. Menü bağlantısı sağla'yı seçin, ardından belgeler ana sayfası menü öğesini ekleyin.
   
   
   
   Bu işlem, geçerli sayfayı Dokümanlar ana sayfanızın ana menüsünün alt öğesi olarak ekler.
7. Artık Dokümanlar Ana sayfası menüsünde sayfanın bağlantısını görüyor olmalısınız.
   
   

Dokümanlar sayfasını düzenleme

Bir sayfayı düzenlemek için:

1. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
2. Geliştirici portalındaki sayfaya gidin.
   Ayrıca, tüm sayfalarınızı listelemek ve bir sayfa seçmek için Drupal yönetim menüsünde İçerik'i de tıklayabilirsiniz.
3. Sayfada Düzenle sekmesini seçin.
   
   
   
4. Gövde bölümünün altındaki Metin Biçimi açılır menüsünde Tam HTML veya Filtrelenmiş HTML'yi seçerek bir görsel düzenleyici açın.
   Sayfa içeriği düzenleyicide görüntülenecektir.
5. Sayfayı gerektiği şekilde düzenleyin.

   

6. Kaydet'i tıklayın.

Herhangi bir belge sayfasını görüntüleme

Bir dokümanın içeriğini görüntülemek için:

1. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
2. Drupal yönetim menüsünde İçerik'i seçin.
3. Görüntülemek istediğiniz dokümanı seçin.

Sayfaların sırasını yeniden düzenleme

Sayfaların sırasını ve iç içe yerleştirme düzeyini Belgeler Ana Sayfası menüsünden değiştirebilirsiniz.

Belgeler Ana Sayfa menüsünde sayfaları yeniden düzenlemek için:

1. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
2. Drupal yönetim menüsünde Yapı > Menüler > Ana menü'yü seçin.
3. Menüdeki her öğenin adının sol tarafında bir simge bulunur. Simgeleri görmüyorsanız Satır ağırlıklarını gizle'yi tıklayın.
4. Bir öğeyi taşımak için simgeyi tıklayıp sürükleyerek yeni bir konuma taşıyın.
   Alt öğeler içeren bir öğeyi sürüklediğinizde alt öğeler de taşınır.
   
   
   
5. Save Configuration'ı (Yapılandırmayı Kaydet) tıklayın.

Altbilgi sayfalarını düzenleme

Portalın altbilgisinde Twitter, Facebook ve LinkedIn için üç sosyal simge ve aşağıdaki URL'lere sahip bağlantılar bulunur:

• Gizlilik Politikası URL'si: <siteURL>/privacy-policy
• <siteURL>/terms-use URL'sine ilişkin Şartlar ve Kullanım
• İletişim sayfaları için <siteURL>/contact-us URL'si

Kendi içeriğinizi eklemek için bu sayfaları düzenleyin.

Bu sayfalar mevcut değilse bunları oluşturun:

1. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
2. Drupal yönetim menüsünde İçerik > İçerik ekle > Temel sayfa'yı seçin.
3. Dokümanın başlığını (ör. Gizlilik Politikası) ve sayfanın içeriğini girin.
4. Özet eklemek için Özeti düzenle'yi tıklayın.
5. Gövde bölümünün altındaki URL yolu ayarları öğesini tıklayın.
6. Otomatik URL takma adı oluştur'u seçin ve URL takma adını gizlilik politikası olarak ayarlayın.
   Varsayılan olarak, bir sayfanın URL'si <siteURL>/content/pageName şeklindedir. URL takma adını ayarlayarak sayfanın açık URL'sini (bu örnekte <siteURL>/privacy-policy) ayarlamış olursunuz.
7. Sayfayı kaydedin.
8. Şartlar ve Kullanım ve İletişim sayfaları için bu işlemi tekrarlayın.

Gizlilik Politikası, Kullanım Şartları veya Bize Ulaşın sayfası gibi bir altbilgi sayfasının içeriğini geliştirici portalınızda düzenlemek için:

1. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
2. Altbilgideki bağlantısını tıklayarak sayfaya gidin. Örneğin, Gizlilik Politikası bağlantısını tıklayın.
3. Düzenleyiciyi açmak için sayfada Düzenle sekmesini tıklayın.
4. Gizlilik Politikası sayfasının içeriğini gerektiği şekilde değiştirin.
5. Kaydet'i tıklayın.
6. Şartlar ve Kullanım ve İletişim sayfaları için bu işlemi tekrarlayın.

Geliştirici portalınızda Twitter, Facebook ve LinkedIn simgeleri gibi sosyal simgelerini düzenlemek için:

1. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
2. Drupal yönetim menüsünde Yapı > Engellemeler'i seçin.
3. Site genelinde Varsayılan Altbilgi bloğunu görene kadar Engellemeler sayfasını aşağı kaydırın.
4. Site genelinde Varsayılan Altbilgi blokuna karşılık gelen configure bağlantısını seçin.
5. Özel İçerik alanında, bir sosyal medya simgesini sağ tıklayın ve pop-up menüden Bağlantıyı Düzenle'yi seçin. İsterseniz Özel İçerik alanındaki simgeyi kaldırarak içeriği de kaldırabilirsiniz.
   
6. Yaptığınız değişiklikleri kaydetmek için Engellemeyi kaydet'i seçin.

Portal sayfasına JavaScript ekleme

Herhangi bir portal sayfasına JavaScript ekleyebilirsiniz. JavaScript eklemenin en kolay yolu, sayfayı düzenlemek ve ardından:

1. Metin Biçimi olarak Tam HTML'yi seçin.
   
2. Sayfanın HTML kaynak kodunu düzenlemek için Kaynak düğmesini seçin.
3. JavaScript'inizi sayfaya ekleyin. Örneğin, sayfa yüklendiğinde bir uyarı kutusu açmak için aşağıdaki kodu ekleyin:
   
   <script language="JavaScript">
alert('Welcome to my page!');
</script>

JavaScript kullanırken dikkat edilmesi gereken bazı noktalar:

• Bir JavaScript dosyasına referans verecekseniz bunu bir düğümün kaynak kodunda yapmayın. Bu işlem statik bir bağlantı oluşturur. Dinamik bir bağlantı oluşturabilmek için bunun yerine PHP kodu kullanın. Bu şekilde, JavaScript dosyasının konumu değişirse ona referans veren tüm portal sayfalarını güncellemeniz gerekmez.
• Bir JavaScript dosyası eklemek istiyorsanız onu portal temasına ekleyin. Drupal modülünün parçasıysa onu modüle ekleyin.
• Drupal'a JavaScript eklemek için Drupal drupal_add_js işlevini de kullanabilirsiniz. Daha fazla bilgi için https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7 adresini ziyaret edin.

Bozuk bağlantı olup olmadığını kontrol etme

İçeriğinizde bozuk bağlantı olup olmadığını kontrol etmek iyi bir uygulamadır. Geliştirici portalı varsayılan olarak, çeşitli sayfa türlerinde bozuk bağlantı olup olmadığını kontrol edecek şekilde ayarlanmıştır. Örneğin, bağlantılar temel sayfalar, makaleler, blog girişleri ve forum konularındaki şekilde kontrol edilir.

Bağlantı kontrolüne sayfa türleri eklemek veya mevcut sayfa türlerini kaldırmak için:

1. Drupal yönetim menüsünde Modüller'i seçin ve Bağlantı Kontrolü modülünün etkin olduğundan emin olun.
2. Drupal yönetim menüsünde Yapılandırma > İçerik yazma > Bağlantı denetleyici'yi seçin.
3. Bozuk bağlantılar için taranmasını istediğiniz içerik türlerini yapılandırın.

Aramayı yapılandırma

Geliştirici portalında, Apache Lucene arama kitaplığını kullanan Apache Solr tarafından uygulanan yerleşik bir arama motoru bulunur. Bu, sitenin arama motorudur ve kullanıcı tüm portal sayfalarının sağ üst köşesindeki arama kutusundan erişir.

Google gibi harici arama motorları da portalınızı dizine ekleyebilir. Geliştirici portalı, harici arama motorlarının portalınızı dizine ekleyip ekleyemeyeceğini kontrol etmenize olanak tanır.

Apache Solr'u yapılandırma

Apache Solr'u, dizine eklenecek içerik türlerini kontrol edecek, bir dizini zorunlu kılacak ve ek yapılandırma görevleri gerçekleştirecek şekilde yapılandırabilirsiniz.

Apache Solr'u yapılandırmak için:

1. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
2. Drupal yönetim menüsünde Yapılandırma > Arama ve meta veri > Apache Solr araması'nı seçin.
3. Bu sayfayı Apache Solr'u yapılandırmak için kullanın.

Google'ın dizine eklemeyi devre dışı bırakma

İçeriğinizi dizine eklemek ve arama motorlarının erişimine açmak da iyi bir uygulamadır. İçeriğiniz varsayılan olarak Google dizinleyicisi tarafından dizine eklenir. Ancak, Google dizine eklemeyi devre dışı bırakabilirsiniz. Geliştirici portalınız herkese açık kullanıma hazır değilse ve bu nedenle içeriğinizin herkes tarafından aranabilir olmasını istemiyorsanız bunu yapmak isteyebilirsiniz.

Google dizine eklemeyi devre dışı bırakmak için:

1. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
2. Drupal yönetim menüsünde Modüller'i seçin.
3. Meta etiketler modülünü etkinleştirin.
4. Yapılandırmayı kaydet'i tıklayın.
5. Drupal yönetim menüsünde Yapılandırma > Arama ve meta veriler > Meta etiket'i seçin.
6. Genel tür için Geçersiz kılma işlemini seçin.
7. Açmak için Gelişmiş bölümünü tıklayın.

   

8. Arama motorlarının bu sayfayı dizine eklemesini engelle onay kutusunu işaretleyin.
9. Kaydet'i tıklayın.

Genel sayfanın Gelişmiş bölümünde, arama motoruyla ilgili başka seçenekler olduğuna dikkat edin. Örneğin, arama motorlarının bir sayfadaki bağlantıları izlemesini engellemek için bir onay kutusunu işaretleyebilirsiniz. Bu onay kutularından birini veya daha fazlasını uygun şekilde işaretleyin.

Uygulamaların nasıl kaydedileceğini belgeleyin

Dokümanlarınızda, geliştiricilerin uygulamalarını geliştirici portalınız üzerinden nasıl kaydedebileceklerine ilişkin talimatlar yer alması önemlidir. Başlangıç noktası olarak aşağıdaki talimatları kullanabilirsiniz. Bu talimatlar, uygulamaların varsayılan geliştirici portalı üzerinden nasıl kaydedileceğini ele alır.

Geliştiricilerin portalınıza nasıl uygulama kaydedeceğini yapılandırmak için Uygulama kaydını yapılandırma bölümüne bakın. Uygulama kaydı sürecini değiştirirseniz aşağıdaki örnek talimatları buna uygun olarak değiştirin.

Bir uygulamayı varsayılan geliştirici portalı üzerinden kaydetmek için:

1. Giriş menüsünde kullanıcı adınızın altındaki Uygulamalarım'ı seçin.
2. Ekle (+) yeni uygulama simgesini tıklayın.

   

3. Uygulama ekle sayfasına uygun değerleri girin:

   Uygulama adı	Uygulamanız için benzersiz bir uygulama adı sağlayın.
   Geri çağırma URL'si	Gerekirse OAuth çağrısının döndürüleceği geri çağırma URL'sini belirtin. Varsayılan olarak, API'leriniz OAuth kullanmıyor olsa bile bu değer zorunludur. API'leriniz OAuth kullanmıyorsa my.site.com gibi temsili bir değer girin.
   Ürün	Bir veya daha fazla API ürünü seçin.

4. Uygulamayı kaydetmek ve uygulama için API anahtarını oluşturmak üzere Uygulama Oluştur'u tıklayın.