Thêm và chỉnh sửa nội dung

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X. thông tin

Sử dụng loại nội dung "Trang cơ bản" của Drupal để thêm tài liệu về API của bạn (chẳng hạn như hướng dẫn cách thực hiện và tài liệu tham khảo API) vào cổng Dịch vụ dành cho nhà phát triển của bạn và thêm những nội dung như video, bản ghi màn hình hoặc lượt tải mã xuống.

Trang Tài liệu được thiết lập bao gồm một số mục nhập ban đầu được sắp xếp theo nhiều danh mục như "Bắt đầu" và "Hướng dẫn". Trang này là điểm bắt đầu để bạn chỉnh sửa. Bằng cách này, bạn có thể thêm các mục nội dung của riêng mình và sắp xếp các mục đó theo cách bạn muốn.

Thêm trang chủ Tài liệu

Theo mặc định, trang chủ Tài liệu nằm tại <siteURL>/document trên cổng thông tin dành cho nhà phát triển. Trang chủ mặc định của cổng thông tin dành cho nhà phát triển chứa đường liên kết đến trang này trong hộp ở đầu Trang chủ:

Bạn cũng có thể thêm đường liên kết đến Tài liệu vào trang này trong trình đơn chính của trình đơn cổng thông tin cho nhà phát triển.

Tuy nhiên, theo mặc định, trang chủ Tài liệu không tồn tại. Vì vậy, bạn phải tạo một trang mới trên cổng thông tin cho nhà phát triển theo đúng URL.

Cách thêm trang chủ Tài liệu vào cổng thông tin dành cho nhà phát triển:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Chọn Nội dung > Thêm nội dung > Trang cơ bản trong trình đơn quản trị Drupal.
  3. Nhập tiêu đề của tài liệu, chẳng hạn như Trang chủ tài liệu và nội dung của trang đầu tiên.
  4. Nhấp vào Chỉnh sửa bản tóm tắt để thêm một bản tóm tắt.
  5. Nhấp vào mục Cài đặt trình đơn bên dưới mục Nội dung.
  6. Chọn Provide a menu link (Cung cấp đường liên kết đến trình đơn), thêm tiêu đề cho đường liên kết rồi chọn <Main menu> (Trình đơn chính) trong Mục mẹ.
    Thao tác này sẽ thêm một đường liên kết đến trình đơn chính cho Trang chủ tài liệu của bạn.
  7. Nhấp vào mục Cài đặt đường dẫn URL bên dưới mục Nội dung.
  8. Bỏ chọn Tạo bí danh URL tự động và đặt bí danh URL thành tài liệu.
    Theo mặc định, URL của một trang là <siteURL>/content/pageName. Bằng cách đặt bí danh URL, bạn đặt một URL rõ ràng của trang, trong trường hợp này là <siteURL>/document.
  9. Lưu trang.
    Lúc này, bạn sẽ thấy một đường liên kết đến trang trong thanh trình đơn và đường liên kết trong hộp trong hộp trên trang chủ hiện đã hoạt động.
    Là quản trị viên, bạn cũng sẽ thấy các nút quản trị nội dung, chẳng hạn như Xem và Chỉnh sửa. Những người không phải là quản trị viên sẽ không thấy các kết quả đó.

Thêm một trang con vào tài liệu của bạn

Khi bạn thêm trang con vào tài liệu:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Chọn Nội dung > Thêm nội dung > Trang cơ bản trong trình đơn quản trị Drupal.
  3. Nhập tiêu đề trang và nội dung.
  4. Nhấp vào Chỉnh sửa bản tóm tắt để thêm một bản tóm tắt.
  5. Nhấp vào mục Cài đặt trình đơn bên dưới mục Nội dung.
  6. Chọn Provide a menu link (Cung cấp đường liên kết đến trình đơn), thêm chọn mục trong trình đơn trên trang chủ của tài liệu.



    Thao tác này sẽ thêm một trang hiện tại làm trang con của trình đơn chính cho Trang chủ tài liệu của bạn.
  7. Giờ đây, bạn sẽ thấy một liên kết đến trang trên trình đơn trang chủ Tài liệu.

Chỉnh sửa trang tài liệu

Cách chỉnh sửa một trang:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Chuyển đến trang trong cổng thông tin dành cho nhà phát triển.
    Bạn cũng có thể nhấp vào Nội dung trong trình đơn quản trị Drupal để liệt kê tất cả các trang của bạn và chọn một trang.
  3. Chọn thẻ Chỉnh sửa trên trang.


  4. Mở một trình chỉnh sửa trực quan bằng cách chọn HTML đầy đủ hoặc HTML đã lọc trong trình đơn thả xuống Định dạng văn bản bên dưới phần Nội dung.
    Bạn sẽ thấy nội dung của trang xuất hiện trong trình chỉnh sửa.
  5. Chỉnh sửa trang nếu cần.

  6. Nhấp vào Lưu.

Hiển thị trang tài liệu bất kỳ

Cách hiển thị nội dung của một tài liệu:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Chọn Nội dung trong trình đơn quản trị Drupal.
  3. Chọn tài liệu bạn muốn xem.

Sắp xếp lại thứ tự các trang

Bạn có thể thay đổi trình tự và cấp độ lồng ghép của các trang trong trình đơn Trang chủ tài liệu.

Cách sắp xếp lại các trang trong trình đơn Trang chủ tài liệu:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Trong trình đơn quản trị Drupal, hãy chọn Cấu trúc > Trình đơn > Trình đơn chính.
  3. Mỗi mục trong trình đơn có một biểu tượng ở bên trái tên mục đó. Nếu bạn không thấy các biểu tượng này, hãy nhấp vào Ẩn trọng số hàng.
  4. Để di chuyển một mục, hãy nhấp và kéo biểu tượng để di chuyển mục đó đến vị trí mới.
    Việc kéo một mục có các mục con cũng di chuyển các mục con đó.


  5. Nhấp vào Lưu cấu hình.

Chỉnh sửa trang chân trang

Chân trang của cổng thông tin chứa 3 biểu tượng mạng xã hội dành cho Twitter, Facebook và LinkedIn và các đường liên kết đến các URL sau:

  • Chính sách quyền riêng tư cho URL <siteURL>/privacy-policy
  • Điều khoản và Sử dụng cho URL <siteURL>/terms-use
  • Các trang liên hệ đến URL <siteURL>/contact-us

Hãy chỉnh sửa những trang này để thêm nội dung của riêng bạn.

Nếu những trang này không tồn tại, hãy tạo chúng:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Chọn Nội dung > Thêm nội dung > Trang cơ bản trong trình đơn quản trị Drupal.
  3. Nhập tiêu đề của tài liệu, chẳng hạn như Chính sách quyền riêng tư và nội dung của trang.
  4. Nhấp vào Chỉnh sửa bản tóm tắt để thêm một bản tóm tắt.
  5. Nhấp vào mục Cài đặt đường dẫn URL bên dưới mục Nội dung.
  6. Chọn Tạo bí danh URL tự động rồi đặt bí danh URL thành chính sách quyền riêng tư.
    Theo mặc định, URL của một trang là <siteURL>/content/pageName. Bằng việc đặt bí danh URL, bạn đặt URL rõ ràng của trang, trong trường hợp này là <siteURL>/privacy-policy.
  7. Lưu trang.
  8. Lặp lại quy trình này cho các trang Điều khoản & Sử dụng và Thông tin liên hệ.

Cách chỉnh sửa nội dung trên trang chân trang (chẳng hạn như Chính sách quyền riêng tư, Điều khoản sử dụng hoặc trang Liên hệ với chúng tôi) trong cổng thông tin dành cho nhà phát triển:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Di chuyển đến trang bằng cách nhấp vào đường liên kết của trang đó ở chân trang. Ví dụ: nhấp vào đường liên kết Chính sách quyền riêng tư.
  3. Nhấp vào thẻ Chỉnh sửa trong trang để mở trình chỉnh sửa.
  4. Thay đổi nội dung của trang Chính sách quyền riêng tư nếu phù hợp.
  5. Nhấp vào Lưu.
  6. Lặp lại quy trình này cho các trang Điều khoản & Sử dụng và Thông tin liên hệ.

Cách chỉnh sửa các biểu tượng mạng xã hội (chẳng hạn như biểu tượng Twitter, Facebook và LinkedIn) trong cổng thông tin dành cho nhà phát triển:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Chọn Cấu trúc > Chặn trong trình đơn quản trị của Drupal.
  3. Di chuyển xuống trang Chặn cho đến khi bạn thấy khối Chân trang mặc định trên toàn trang web.
  4. Chọn đường liên kết configure tương ứng với khối Chân trang mặc định trên toàn trang web.
  5. Trong khu vực Nội dung tuỳ chỉnh, hãy nhấp chuột phải vào một biểu tượng mạng xã hội rồi chọn Chỉnh sửa đường liên kết từ trình đơn bật lên. Hoặc xoá biểu tượng khỏi phần Nội dung tuỳ chỉnh để gỡ bỏ biểu tượng đó.
  6. Chọn Lưu khối để lưu các thay đổi.

Thêm JavaScript vào trang cổng thông tin

Bạn có thể thêm JavaScript vào bất kỳ trang cổng thông tin nào. Cách dễ nhất để thêm JavaScript là chỉnh sửa trang, sau đó:

  1. Chọn HTML đầy đủ làm Định dạng văn bản.
  2. Chọn nút Nguồn để chỉnh sửa mã nguồn HTML cho trang.
  3. Thêm JavaScript vào trang. Ví dụ: để hộp cảnh báo bật lên khi trang tải, hãy thêm mã sau:

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

Một số điểm cần cân nhắc khi sử dụng JavaScript:

  • Nếu bạn định tham chiếu đến một tệp JavaScript, đừng thực hiện việc này trong mã nguồn của nút, vì điều này sẽ tạo ra một đường liên kết tĩnh. Thay vào đó, hãy sử dụng mã PHP để bạn có thể tạo đường liên kết động. Theo đó, nếu vị trí của tệp JavaScript thay đổi, bạn không phải cập nhật mọi trang cổng thông tin tham chiếu đến tệp đó.
  • Nếu bạn muốn đưa tệp JavaScript vào, hãy thêm tệp đó vào giao diện cổng. Hoặc nếu mã này thuộc một mô-đun Drupal, hãy thêm mô-đun đó vào mô-đun.
  • Bạn cũng có thể sử dụng hàm drupal_add_js của Drupal để thêm JavaScript vào Drupal. Để biết thêm thông tin, hãy xem https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7.

Bạn nên kiểm tra nội dung của mình để tìm các đường liên kết bị hỏng. Theo mặc định, cổng thông tin dành cho nhà phát triển được thiết lập để kiểm tra nhiều loại trang nhằm tìm các đường liên kết bị hỏng. Ví dụ: chúng tôi sẽ kiểm tra đường liên kết trong các trang cơ bản, bài viết, mục nhập trên blog và chủ đề trên diễn đàn.

Cách thêm hoặc xoá các loại trang khỏi bước kiểm tra đường liên kết:

  1. Trong trình đơn quản trị Drupal, hãy chọn Mô-đun và đảm bảo rằng mô-đun Trình kiểm tra liên kết đã được bật.
  2. Trong trình đơn quản trị Drupal, hãy chọn Cấu hình > Tạo nội dung > Trình kiểm tra đường liên kết.
  3. Định cấu hình loại nội dung mà bạn muốn quét để tìm đường liên kết bị hỏng.

Định cấu hình tìm kiếm

Cổng thông tin dành cho nhà phát triển cung cấp một công cụ tìm kiếm tích hợp sẵn do Apache Solr triển khai. Công cụ này sử dụng thư viện tìm kiếm Apache Lucene. Đây là công cụ tìm kiếm cho chính trang web đó mà người dùng truy cập thông qua hộp tìm kiếm ở góc trên bên phải của tất cả các trang cổng.

Các công cụ tìm kiếm bên ngoài, chẳng hạn như Google, cũng có thể lập chỉ mục cổng thông tin của bạn. Cổng thông tin cho nhà phát triển cho phép bạn kiểm soát việc các công cụ tìm kiếm bên ngoài có thể lập chỉ mục cổng thông tin của bạn hay không.

Định cấu hình Apache Solr

Bạn có thể định cấu hình Apache Solr để kiểm soát các loại nội dung cần lập chỉ mục, buộc lập chỉ mục và thực hiện các tác vụ định cấu hình bổ sung.

Cách định cấu hình Apache Solr:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Trong trình đơn quản trị Drupal, hãy chọn Cấu hình > Tìm kiếm và siêu dữ liệu > Tìm kiếm Apache Solr.
  3. Sử dụng trang này để định cấu hình Apache Solr.

Tắt tính năng lập chỉ mục của Google

Bạn cũng nên lập chỉ mục nội dung của mình và cung cấp nội dung đó cho các công cụ tìm kiếm. Theo mặc định, nội dung của bạn sẽ được trình lập chỉ mục của Google lập chỉ mục. Tuy nhiên, bạn có thể chọn tắt tính năng lập chỉ mục của Google. Bạn nên làm việc này nếu cổng thông tin của nhà phát triển chưa sẵn sàng sử dụng công khai, đồng thời bạn không muốn mọi người có thể tìm kiếm nội dung của mình.

Cách tắt tính năng lập chỉ mục của Google:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Chọn Mô-đun trong trình đơn quản trị Drupal.
  3. Bật mô-đun Metatags.
  4. Nhấp vào Lưu cấu hình.
  5. Trong trình đơn quản trị Drupal, hãy chọn Cấu hình > Tìm kiếm và siêu dữ liệu > Thẻ meta.
  6. Chọn thao tác Override (Ghi đè) cho Global type (Loại chung).
  7. Nhấp vào phần Advanced (Nâng cao) để mở phần này.

  8. Chọn hộp kiểm Ngăn công cụ tìm kiếm lập chỉ mục trang này.
  9. Nhấp vào Lưu.

Xin lưu ý rằng có các tuỳ chọn khác liên quan đến công cụ tìm kiếm trong phần Nâng cao của trang Toàn cục. Ví dụ: bạn có thể đánh dấu vào hộp để ngăn công cụ tìm kiếm đi theo các đường liên kết trên một trang. Đánh dấu vào một hoặc nhiều hộp đánh dấu trong số này nếu phù hợp.

Tài liệu về cách đăng ký ứng dụng

Điều quan trọng là tài liệu của bạn phải có hướng dẫn về cách nhà phát triển có thể đăng ký ứng dụng qua cổng thông tin dành cho nhà phát triển. Bạn có thể bắt đầu bằng cách tham khảo hướng dẫn sau – những hướng dẫn này trình bày cách đăng ký ứng dụng thông qua cổng thông tin mặc định dành cho nhà phát triển.

Để định cấu hình cách nhà phát triển đăng ký ứng dụng trên cổng của bạn, hãy xem bài viết Định cấu hình đăng ký ứng dụng để tìm hiểu thêm. Nếu bạn sửa đổi quy trình đăng ký ứng dụng, hãy sửa đổi hướng dẫn mẫu bên dưới cho phù hợp.

Cách đăng ký ứng dụng thông qua cổng thông tin mặc định dành cho nhà phát triển:

  1. Chọn Ứng dụng của tôi bên dưới tên người dùng của bạn trong trình đơn đăng nhập.
  2. Nhấp vào biểu tượng ứng dụng mới Thêm (+).

  3. Nhập các giá trị thích hợp trên trang Thêm ứng dụng:
    Tên ứng dụng Cung cấp Tên ứng dụng riêng biệt cho ứng dụng của bạn.
    URL gọi lại

    Nếu cần, hãy cung cấp URL gọi lại mà lệnh gọi OAuth sẽ trả về.

    Theo mặc định, giá trị này là bắt buộc ngay cả khi API của bạn không sử dụng OAuth. Nếu API của bạn không sử dụng OAuth, hãy nhập một giá trị giả như my.site.com.
    Sản phẩm Chọn một hoặc nhiều sản phẩm API.
  4. Nhấp vào Tạo ứng dụng để đăng ký ứng dụng và tạo khoá API cho ứng dụng.