Dodawanie i edytowanie treści

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Za pomocą typu treści „Basic Page” (Strona podstawowa) w Dupal możesz dodawać do swojego portalu usług dla deweloperów dokumentację dotyczącą interfejsu API (np. instrukcje czy dokumenty referencyjne interfejsu API), a także dodawać treści takie jak filmy, screencasty czy pliki do pobrania.

Strona Dokumentacja zawiera kilka początkowych wpisów podzielonych na różne kategorie, np. „Pierwsze kroki” i „Samouczki”. Strona to punkt wyjścia do edytowania. W ten sposób możesz dodawać własne wpisy z treścią i porządkować je w wybrany przez siebie sposób.

Dodawanie strony głównej dokumentacji

Domyślnie strona główna dokumentacji znajduje się pod adresem <siteURL>/dokumentacja w portalu dla programistów. Domyślna strona główna portalu dla deweloperów zawiera link do tej strony w polu u góry strony głównej:

W menu głównym w menu portalu dla programistów możesz też dodać do tej strony link do dokumentacji.

Jednak domyślnie strona główna dokumentacji nie istnieje, więc musisz utworzyć nową stronę w portalu dla programistów pod prawidłowym adresem URL.

Aby dodać stronę główną dokumentacji do portalu dla deweloperów:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
  2. W menu administrowania Drupal wybierz Treść > Dodaj treść > Podstawowa.
  3. Wpisz tytuł dokumentu, np. stronę główną dokumentacji, i zawartość pierwszej strony.
  4. Aby dodać podsumowanie, kliknij Edytuj podsumowanie.
  5. Kliknij element Ustawienia menu pod sekcją Treść.
  6. Wybierz Podaj link do menu, dodaj tytuł linku i w elemencie nadrzędnym wybierz <Menu główne>.
    Spowoduje to dodanie linku do menu głównego strony głównej dokumentacji.
  7. Kliknij element Ustawienia ścieżki adresu URL pod sekcją Treść.
  8. Odznacz Generuj automatyczny alias adresu URL i ustaw alias adresu URL na potrzeby dokumentacji.
    Domyślnie adres URL strony to <siteURL>/content/pageName. Ustawiając alias adresu URL, ustawiasz bezpośredni adres URL strony – w tym przypadku na <siteURL>/dokumentacja.
  9. Zapisz stronę.
    Link do strony powinien być teraz widoczny na pasku menu, a link w polu na stronie głównej powinien działać.
    Jako administrator zobaczysz też przyciski administrowania treścią, takie jak Wyświetl i Edytuj. Osoby niebędące administratorami ich nie zobaczą.

Dodawanie strony podrzędnej do dokumentacji

Podczas dodawania stron podrzędnych do dokumentacji:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
  2. W menu administrowania Drupal wybierz Treść > Dodaj treść > Podstawowa.
  3. Wpisz tytuł i treść strony.
  4. Aby dodać podsumowanie, kliknij Edytuj podsumowanie.
  5. Kliknij element Ustawienia menu pod sekcją Treść.
  6. Kliknij Podaj link do menu i dodaj opcję menu na stronie głównej dokumentacji.



    Spowoduje to dodanie bieżącej strony jako elementu podrzędnego menu głównego strony głównej dokumentacji.
  7. W menu strony głównej Dokumentacja powinien być teraz widoczny link do tej strony.

Edytowanie strony dokumentacji

Aby edytować stronę:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
  2. Otwórz stronę w portalu dla deweloperów.
    Możesz też kliknąć Treść w menu administrowania Drupal, aby wyświetlić listę wszystkich stron i wybrać jedną z nich.
  3. Kliknij na stronie kartę Edytuj.


  4. Otwórz edytor wizualny, wybierając Pełny kod HTML lub Filtrowany HTML z menu Format tekstu pod sekcją Treść.
    Zawartość strony powinna wyświetlić się w edytorze.
  5. Zmodyfikuj stronę.

  6. Kliknij Zapisz.

Wyświetlanie dowolnej strony dokumentacji

Aby wyświetlić treść dokumentu:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
  2. W menu administrowania Drupal wybierz Treść.
  3. Wybierz dokument, który chcesz wyświetlić.

Zmiana kolejności stron

Sekwencję i poziom zagnieżdżenia stron możesz zmienić w menu głównym Dokumentacja.

Aby zmienić kolejność stron w menu głównym dokumentacji:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
  2. W menu administrowania Drupal wybierz Struktura > Menu > Menu główne.
  3. Każda pozycja w menu ma ikonę po lewej stronie nazwy. Jeśli nie widzisz tych ikon, kliknij Ukryj wagi wierszy.
  4. Aby przenieść element, kliknij i przeciągnij ikonę w nowe miejsce.
    Przeciągnięcie elementu z elementami podrzędnymi spowoduje też przeniesienie elementów podrzędnych.


  5. Kliknij Save Configuration (Zapisz konfigurację).

Edytowanie stron stopek

Stopka portalu zawiera 3 ikony społecznościowe dla Twittera, Facebooka i LinkedIn oraz linki z tymi adresami URL:

  • Polityka prywatności pod adresem URL <siteURL>/privacy-policy
  • Warunki i korzystanie z adresu URL <siteURL>/terms-use
  • Skontaktuj się ze stronami pod adresem URL <siteURL>/contact-us

Edytuj te strony, aby dodać własne treści.

Jeśli te strony nie istnieją, utwórz je:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
  2. W menu administrowania Drupal wybierz Treść > Dodaj treść > Podstawowa.
  3. Wpisz tytuł dokumentu, na przykład Politykę prywatności, i treść strony.
  4. Aby dodać podsumowanie, kliknij Edytuj podsumowanie.
  5. Kliknij element Ustawienia ścieżki adresu URL pod sekcją Treść.
  6. Wybierz Wygeneruj automatyczny alias adresu URL i jako alias adresu URL ustaw zasadę ochrony prywatności.
    Domyślnie adres URL strony to <siteURL>/content/pageName. Korzystając z aliasu adresu URL, ustawiasz bezpośredni adres URL strony – w tym przypadku to <siteURL>/privacy-policy.
  7. Zapisz stronę.
  8. Powtórz te czynności na stronach Warunki korzystania z usługi oraz Dane kontaktowe.

Aby edytować zawartość strony stopki w portalu dla deweloperów, na przykład politykę prywatności, warunki korzystania z usługi lub stronę „Skontaktuj się z nami”:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
  2. Przejdź na tę stronę, klikając jej link w stopce. Kliknij na przykład link Polityka prywatności.
  3. Na stronie kliknij kartę Edytuj, aby otworzyć edytor.
  4. Zmień treść strony Polityka prywatności zgodnie z potrzebami.
  5. Kliknij Zapisz.
  6. Powtórz te czynności na stronach Warunki korzystania z usługi oraz Dane kontaktowe.

Aby edytować ikony społecznościowe, takie jak Twitter, Facebook i LinkedIn, w portalu dla programistów:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
  2. W menu administrowania Drupal wybierz Struktura > Blokady.
  3. Przewiń stronę Blokady w dół, aż zobaczysz blok Domyślna stopka dla całej witryny.
  4. Wybierz link configure odpowiadający blokowi domyślnej stopki dla całej witryny.
  5. W obszarze Treści niestandardowe kliknij prawym przyciskiem myszy ikonę społecznościową i z menu wybierz Edytuj link. Możesz też usunąć ikonę z obszaru Treść niestandardowa, aby ją usunąć.
  6. Wybierz Zapisz blok, aby zapisać zmiany.

Dodawanie kodu JavaScript do strony portalu

Do każdej strony portalu możesz dodać JavaScript. Najłatwiejszym sposobem dodania JavaScriptu jest edycja strony, a następnie:

  1. Jako Format tekstowy wybierz Pełny kod HTML.
  2. Kliknij przycisk Źródło, by edytować kod źródłowy HTML strony.
  3. Dodaj do strony kod JavaScript. Aby na przykład wyświetlać okno alertu po wczytaniu strony, dodaj ten kod:

    <script language="JavaScript">
    alert('Welcome to my page!');
    </script>

Kilka uwag na temat używania JavaScriptu:

  • Jeśli masz zamiar odwołać się do pliku JavaScript, nie rób tego w kodzie źródłowym węzła, ponieważ spowoduje to utworzenie linku statycznego. Zamiast tego użyj kodu PHP, aby utworzyć link dynamiczny. Dzięki temu, jeśli zmieni się lokalizacja pliku JavaScript, nie będzie trzeba aktualizować wszystkich stron portalu, które się do niego odwołują.
  • Jeśli chcesz dołączyć plik JavaScript, dodaj go do motywu portalu. Jeśli jest on częścią modułu Drupal, dodaj go do modułu.
  • Aby dodać JavaScript w aplikacji Drupal, możesz też użyć funkcji drupal_add_js. Więcej informacji znajdziesz na stronie https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7.

Warto sprawdzać treść pod kątem uszkodzonych linków. Domyślnie portal dla deweloperów jest skonfigurowany w taki sposób, aby sprawdzać różne typy stron pod kątem uszkodzonych linków. Linki są na przykład sprawdzane na podstawowych stronach, w artykułach, wpisach na blogu i w tematach na forach.

Aby dodać typy stron do sprawdzania linków lub je z niego usunąć:

  1. W menu administracyjnym Drupal wybierz Modules (Moduły) i upewnij się, że moduł Narzędzie do sprawdzania linków jest włączony.
  2. W menu administrowania Drupal wybierz Konfiguracja > Tworzenie treści > Narzędzie do sprawdzania linków.
  3. Skonfiguruj typy treści, które mają być skanowane pod kątem uszkodzonych linków.

Konfigurowanie wyszukiwania

Portal dla programistów zawiera wbudowaną wyszukiwarkę, która została zaimplementowana przez Apache Solr i korzysta z biblioteki wyszukiwania Apache Lucene. Jest to wyszukiwarka dla witryny, do której użytkownik uzyskuje dostęp przez pole wyszukiwania w prawym górnym rogu wszystkich stron portalu.

Zewnętrzne wyszukiwarki, takie jak Google, również mogą indeksować Twój portal. Portal dla programistów pozwala określić, czy zewnętrzne wyszukiwarki mogą go indeksować.

Konfigurowanie Apache Solr

Apache Solr pozwala kontrolować typy treści do indeksowania, wymuszać indeksowanie i wykonywać dodatkowe zadania konfiguracyjne.

Aby skonfigurować Apache Solr:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
  2. W menu administrowania Drupal wybierz Konfiguracja > Wyszukiwanie i metadane > Wyszukiwanie Apache Solr.
  3. Użyj tej strony, aby skonfigurować Apache Solr.

Wyłączanie indeksowania przez Google

Warto też zindeksować treść i udostępnić ją wyszukiwarkom. Domyślnie treści są indeksowane przez narzędzie indeksujące Google. Możesz jednak wyłączyć indeksowanie Google. Możesz to zrobić, jeśli Twój portal dla deweloperów nie jest gotowy do użytku publicznego i nie chcesz, aby Twoje treści były dostępne publicznie.

Aby wyłączyć indeksowanie Google:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
  2. W menu administracyjnym Drupal wybierz Modules (Moduły).
  3. Włącz moduł Metatagi.
  4. Kliknij Save configuration.
  5. W menu administrowania Drupal wybierz Konfiguracja > Wyszukiwanie i metadane > Metatag.
  6. W przypadku opcji Typ globalny wybierz operację Zastąp.
  7. Kliknij sekcję Zaawansowane, aby ją otworzyć.

  8. Zaznacz pole wyboru Zablokuj wyszukiwarkom indeksowanie tej strony.
  9. Kliknij Zapisz.

Zwróć uwagę, że w sekcji Zaawansowane na stronie Globalnej znajdują się inne opcje związane z wyszukiwarkami. Możesz na przykład zaznaczyć pole wyboru, aby uniemożliwić wyszukiwarkom korzystanie z linków na stronie. Odpowiednio zaznacz jedno lub więcej pól wyboru.

Dokumentacja rejestrowania aplikacji

Dokumentacja powinna zawierać instrukcje dotyczące rejestrowania aplikacji przez portal dla deweloperów. Na początek możesz skorzystać z podanych niżej instrukcji. Zawierają one instrukcje rejestrowania aplikacji przy użyciu domyślnego portalu dla programistów.

Jeśli chcesz skonfigurować sposób, w jaki deweloperzy rejestrują aplikacje w portalu, przeczytaj artykuł Konfigurowanie rejestracji aplikacji. Jeśli modyfikujesz proces rejestracji aplikacji, odpowiednio zmodyfikuj przykładowe instrukcje poniżej.

Aby zarejestrować aplikację w domyślnym portalu dla deweloperów:

  1. W menu logowania pod nazwą użytkownika wybierz Moje aplikacje.
  2. Kliknij ikonę nowej aplikacji Dodaj (+).

  3. Na stronie Dodaj aplikację wpisz odpowiednie wartości:
    Nazwa aplikacji Nadaj aplikacji unikalną nazwę.
    URL wywołania zwrotnego

    W razie potrzeby podaj URL wywołania zwrotnego, na który powinno być zwracane wywołanie OAuth.

    Domyślnie ta wartość jest wymagana nawet wtedy, gdy Twoje interfejsy API nie używają protokołu OAuth. Jeśli Twoje interfejsy API nie korzystają z protokołu OAuth, wpisz przykładową wartość, np. moja.witryna.com.
    Produkt Wybierz co najmniej jedną usługę API..
  4. Kliknij Utwórz aplikację, aby zarejestrować aplikację i wygenerować dla niej klucz interfejsu API.