เพิ่มและแก้ไขเนื้อหา

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล

ใช้ประเภทเนื้อหา "หน้าพื้นฐาน" ของ Drupal เพื่อเพิ่มเอกสารประกอบเกี่ยวกับ API เช่น คู่มือวิธีใช้และเอกสารอ้างอิง API ลงในพอร์ทัลบริการสำหรับนักพัฒนาซอฟต์แวร์ และรวมเนื้อหาอย่างวิดีโอ, Screencast หรือการดาวน์โหลดโค้ด

หน้าเอกสารประกอบจะตั้งค่าโดยมีรายการเริ่มต้นบางส่วนที่จัดไว้เป็นหมวดหมู่ต่างๆ เช่น "เริ่มต้นใช้งาน" และ "บทแนะนำ" หน้านี้เป็นจุดเริ่มต้นให้คุณแก้ไข ด้วยวิธีนี้คุณจึงสามารถเพิ่มรายการเนื้อหาของคุณเองและจัดระเบียบรายการเหล่านั้นได้ตามต้องการ

การเพิ่มหน้าแรกของเอกสาร

โดยค่าเริ่มต้น หน้าแรกของเอกสารจะอยู่ที่ <siteURL>/เอกสารในพอร์ทัลนักพัฒนาซอฟต์แวร์ หน้าแรกเริ่มต้นของพอร์ทัลนักพัฒนาซอฟต์แวร์มีลิงก์ไปยังหน้านี้ในช่องที่ด้านบนของหน้าแรก

นอกจากนี้ คุณยังเพิ่มลิงก์เอกสารประกอบในหน้านี้ได้ในเมนูหลักของเมนูพอร์ทัลนักพัฒนาซอฟต์แวร์

อย่างไรก็ตาม หน้าแรกของเอกสารประกอบจะไม่มีอยู่โดยค่าเริ่มต้น ดังนั้นคุณจะต้องสร้างหน้าใหม่ในพอร์ทัลนักพัฒนาซอฟต์แวร์ที่ URL ที่ถูกต้อง

วิธีเพิ่มหน้าแรกของเอกสารประกอบลงในพอร์ทัลนักพัฒนาซอฟต์แวร์

1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
2. เลือกเนื้อหา > เพิ่มเนื้อหา > หน้าพื้นฐาน ในเมนูการดูแลระบบ Drupal
3. ป้อนชื่อเอกสาร เช่น หน้าแรกของเอกสาร และเนื้อหาของหน้าแรก
4. คลิกแก้ไขสรุป เพื่อเพิ่มสรุป
5. คลิกรายการการตั้งค่า เมนูที่อยู่ใต้ส่วนเนื้อหา
6. เลือกระบุลิงก์เมนู เพิ่มชื่อลิงก์ แล้วเลือก <เมนูหลัก> ในรายการหลัก
   การดำเนินการนี้จะเพิ่มลิงก์ไปยังเมนูหลักสำหรับหน้าแรกของเอกสารประกอบ
7. คลิกรายการการตั้งค่าเส้นทาง URL ใต้ส่วนเนื้อหา
8. ยกเลิกการเลือกสร้างชื่อแทน URL อัตโนมัติและตั้งค่าชื่อแทน URL เป็นเอกสาร
   โดยค่าเริ่มต้น URL ของหน้าคือ <siteURL>/content/pageName การตั้งค่าชื่อแทน URL เป็นการตั้งค่า URL ที่ชัดเจนของหน้า ในกรณีนี้เป็น <siteURL>/documentation
9. บันทึกหน้าเว็บ
   ตอนนี้คุณน่าจะเห็นลิงก์ไปยังหน้าดังกล่าวในแถบเมนูแล้ว และลิงก์ในกล่องที่อยู่ในหน้าแรกจะใช้งานได้แล้ว
   ในฐานะผู้ดูแลระบบ คุณจะเห็นปุ่มการดูแลระบบเนื้อหา เช่น ดูและแก้ไข ผู้ที่ไม่ใช่ผู้ดูแลระบบจะไม่เห็นเนื้อหาเหล่านั้น

การเพิ่มหน้าย่อยลงในเอกสารประกอบ

เมื่อเพิ่มหน้าย่อยลงในเอกสารประกอบ ให้ทำดังนี้

1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
2. เลือกเนื้อหา > เพิ่มเนื้อหา > หน้าพื้นฐาน ในเมนูการดูแลระบบ Drupal
3. ป้อนชื่อหน้าและเนื้อหา
4. คลิกแก้ไขสรุป เพื่อเพิ่มสรุป
5. คลิกรายการการตั้งค่า เมนูที่อยู่ใต้ส่วนเนื้อหา
6. เลือกระบุลิงก์เมนู แล้วเพิ่มรายการในเมนูหน้าแรกของเอกสารประกอบ ให้เลือก
   
   
   
   การดำเนินการนี้จะเพิ่มหน้าปัจจุบันเป็นหน้าย่อยของเมนูหลักสำหรับหน้าแรกของเอกสารประกอบ
7. คุณควรจะเห็นลิงก์ไปยังหน้าเว็บดังกล่าวในเมนูหน้าแรกของเอกสารประกอบแล้ว
   
   

การแก้ไขหน้าเอกสาร

วิธีแก้ไขหน้า

1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
2. ไปที่หน้าในพอร์ทัลนักพัฒนาซอฟต์แวร์
   หรือจะคลิกเนื้อหาในเมนูการดูแลระบบ Drupal เพื่อแสดงหน้าทั้งหมดและเลือกเพียงหน้าเดียว
3. เลือกแท็บแก้ไขในหน้าเว็บ
   
   
   
4. เปิดโปรแกรมแก้ไขภาพโดยเลือก HTML แบบเต็มหรือ HTML ที่กรองแล้วในเมนูแบบเลื่อนลง "รูปแบบข้อความ" ใต้ส่วนเนื้อหา
   คุณควรจะเห็นเนื้อหาของหน้าแสดงอยู่ในเครื่องมือแก้ไข
5. แก้ไขหน้าเว็บตามความจำเป็น

   

6. คลิก "บันทึก"

การแสดงหน้าเอกสารประกอบ

หากต้องการแสดงเนื้อหาของเอกสาร ให้ทำดังนี้

1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
2. เลือกเนื้อหาในเมนูการดูแลระบบ Drupal
3. เลือกเอกสารที่ต้องการดู

การจัดเรียงลำดับของหน้าเว็บใหม่

คุณสามารถเปลี่ยนลำดับและระดับการซ้อนของหน้าได้ในเมนูหน้าแรกของเอกสารประกอบ

วิธีจัดเรียงหน้าใหม่ในเมนูหน้าแรกของเอกสาร

1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
2. ในเมนูการดูแลระบบ Drupal ให้เลือกโครงสร้าง > เมนู > เมนูหลัก
3. แต่ละรายการในเมนูจะมีไอคอนอยู่ทางด้านซ้ายของชื่อ หากไม่เห็นไอคอน ให้คลิกซ่อนน้ำหนักของแถว
4. หากต้องการย้ายรายการ ให้คลิกและลากไอคอนเพื่อย้ายไปยังตำแหน่งใหม่
   การลากรายการที่มีรายการย่อยจะเป็นการย้ายรายการย่อยด้วย
   
   
   
5. คลิก Save Configuration

การแก้ไขหน้าส่วนท้าย

ส่วนท้ายของพอร์ทัลมีไอคอนโซเชียล 3 ไอคอนสำหรับ Twitter, Facebook และ LinkedIn และลิงก์ที่มี URL ต่อไปนี้

• นโยบายความเป็นส่วนตัวของ URL <siteURL>/privacy-policy
• ข้อกำหนดและการใช้ URL <siteURL>/terms-use
• หน้าติดต่อไปยัง URL <siteURL>/contact-us

แก้ไขหน้าเว็บเหล่านี้เพื่อเพิ่มเนื้อหาของคุณเอง

หากไม่มีหน้าเหล่านี้ ให้สร้างขึ้นมาดังนี้

1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
2. เลือกเนื้อหา > เพิ่มเนื้อหา > หน้าพื้นฐาน ในเมนูการดูแลระบบ Drupal
3. ป้อนชื่อเอกสาร เช่น นโยบายความเป็นส่วนตัวและเนื้อหาของหน้า
4. คลิกแก้ไขสรุป เพื่อเพิ่มสรุป
5. คลิกรายการการตั้งค่าเส้นทาง URL ใต้ส่วนเนื้อหา
6. เลือกสร้างชื่อแทน URL อัตโนมัติ และตั้งค่าชื่อแทน URL เป็นนโยบายความเป็นส่วนตัว
   โดยค่าเริ่มต้น URL ของหน้าคือ <siteURL>/content/pageName การตั้งค่าชื่อแทน URL เป็นการตั้งค่า URL ที่ชัดเจนของหน้าเว็บ ซึ่งในกรณีนี้เป็น <siteURL>/privacy-policy
7. บันทึกหน้าเว็บ
8. ทำขั้นตอนนี้ซ้ำสำหรับหน้าข้อกำหนดและการใช้งาน รวมถึงหน้าติดต่อ

หากต้องการแก้ไขเนื้อหาของหน้าส่วนท้าย เช่น นโยบายความเป็นส่วนตัว ข้อกำหนดในการใช้งาน หรือหน้าติดต่อเรา ในพอร์ทัลสำหรับนักพัฒนาแอป ให้ทำดังนี้

1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
2. ไปที่หน้านั้นโดยคลิกลิงก์ในส่วนท้าย เช่น คลิกลิงก์นโยบายความเป็นส่วนตัว
3. คลิกแท็บแก้ไขในหน้าเพื่อเปิดตัวแก้ไข
4. เปลี่ยนแปลงเนื้อหาของหน้านโยบายความเป็นส่วนตัวตามความเหมาะสม
5. คลิกบันทึก
6. ทำขั้นตอนนี้ซ้ำสำหรับหน้าข้อกำหนดและการใช้งาน รวมถึงหน้าติดต่อ

หากต้องการแก้ไขไอคอนโซเชียล เช่น ไอคอน Twitter, Facebook และ LinkedIn ในพอร์ทัลนักพัฒนาซอฟต์แวร์ ให้ทำดังนี้

1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
2. เลือกโครงสร้าง > บล็อก ในเมนูการดูแลระบบ Drupal
3. เลื่อนหน้าการบล็อกลงจนกว่าจะเห็นบล็อกส่วนท้ายเริ่มต้นทั้งเว็บไซต์
4. เลือกลิงก์configureที่สอดคล้องกับบล็อกส่วนท้ายเริ่มต้นสำหรับทั้งเว็บไซต์
5. ในพื้นที่เนื้อหาที่กำหนดเอง ให้คลิกขวาที่ไอคอนโซเชียลแล้วเลือกแก้ไขลิงก์จากเมนูป๊อปอัป หรือลบไอคอนออกจากพื้นที่เนื้อหาที่กำหนดเองเพื่อนำออก
   
6. เลือกบันทึกช่วงเพื่อบันทึกการเปลี่ยนแปลง

การเพิ่ม JavaScript ในหน้าพอร์ทัล

คุณสามารถเพิ่ม JavaScript ในหน้าพอร์ทัลใดก็ได้ วิธีที่ง่ายที่สุดในการเพิ่ม JavaScript คือการแก้ไขหน้าเว็บ จากนั้นให้ทำดังนี้

1. เลือก HTML แบบเต็มเป็นรูปแบบข้อความ
   
2. เลือกปุ่มแหล่งที่มาเพื่อแก้ไขซอร์สโค้ด HTML ของหน้านั้น
3. เพิ่ม JavaScript ลงในหน้าเว็บ เช่น หากต้องการให้ช่องการแจ้งเตือนปรากฏขึ้นเมื่อโหลดหน้าเว็บ ให้เพิ่มโค้ดต่อไปนี้
   
   <script language="JavaScript">
alert('Welcome to my page!');
</script>

ข้อควรพิจารณาในการใช้ JavaScript มีดังนี้

• หากคุณกำลังจะอ้างอิงไฟล์ JavaScript อย่าทำเช่นนั้นในซอร์สโค้ดของโหนดเพราะจะเป็นการสร้างลิงก์แบบคงที่ ให้ใช้โค้ด PHP แทนเพื่อให้คุณสร้างลิงก์แบบไดนามิกได้ ด้วยวิธีนี้ หากตำแหน่งของไฟล์ JavaScript มีการเปลี่ยนแปลง คุณจะไม่ต้องอัปเดตหน้าพอร์ทัลทั้งหมดที่อ้างอิง
• หากต้องการรวมไฟล์ JavaScript ให้เพิ่มไฟล์ลงในธีมของพอร์ทัล หรือหากเป็นส่วนหนึ่งของโมดูล Drupal ให้เพิ่มโมดูลดังกล่าวไปยังโมดูล
• หรือจะใช้ฟังก์ชัน Drupal drupal_add_js เพื่อเพิ่ม JavaScript ใน Drupal ด้วย ดูข้อมูลเพิ่มเติมได้ที่ https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7

การตรวจหาลิงก์ที่ใช้งานไม่ได้

แนวทางปฏิบัติที่ดีคือการตรวจสอบเนื้อหาของคุณเพื่อหาลิงก์เสีย โดยค่าเริ่มต้น พอร์ทัลนักพัฒนาซอฟต์แวร์จะตั้งค่าไว้ให้ตรวจสอบหน้าประเภทต่างๆ เพื่อหาลิงก์เสีย เช่น ระบบจะตรวจสอบลิงก์ในหน้าพื้นฐาน บทความ ข้อมูลในบล็อก และหัวข้อในฟอรัม

วิธีเพิ่มหรือนำประเภทหน้าเว็บออกจากการตรวจสอบลิงก์

1. ในเมนูการดูแลระบบ Drupal ให้เลือกโมดูล และตรวจสอบว่าเปิดใช้โมดูลเครื่องมือตรวจสอบลิงก์แล้ว
2. ในเมนูการดูแลระบบ Drupal ให้เลือกการกำหนดค่า > การเขียนเนื้อหา > เครื่องมือตรวจสอบลิงก์
3. กำหนดค่าประเภทเนื้อหาที่ต้องการสแกนหาลิงก์ที่เสีย

การกำหนดค่าการค้นหา

พอร์ทัลนักพัฒนาซอฟต์แวร์มีเครื่องมือค้นหาในตัวที่ติดตั้งใช้งานโดย Apache Solr ซึ่งใช้ไลบรารีการค้นหา Apache Lucene ซึ่งเป็นเครื่องมือค้นหาสำหรับเว็บไซต์นั้นเอง ซึ่งผู้ใช้จะเข้าถึงผ่านช่องค้นหาที่มุมขวาบนของหน้าพอร์ทัลทั้งหมด

เครื่องมือค้นหาภายนอก เช่น Google ก็สามารถจัดทำดัชนีพอร์ทัลของคุณได้เช่นกัน พอร์ทัลนักพัฒนาซอฟต์แวร์ช่วยให้คุณควบคุมได้ว่าจะให้เครื่องมือค้นหาภายนอกจัดทำดัชนีพอร์ทัลของคุณหรือไม่

การกำหนดค่า Apache Solr

คุณกำหนดค่า Apache Solr เพื่อควบคุมประเภทเนื้อหาที่จะจัดทำดัชนี บังคับดัชนี และดำเนินการกำหนดค่าเพิ่มเติมได้

วิธีกำหนดค่า Apache Solr ให้ทำดังนี้

1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
2. ในเมนูการดูแลระบบ Drupal ให้เลือกการกำหนดค่า > การค้นหาและข้อมูลเมตา > การค้นหา Apache Solr
3. ใช้หน้านี้เพื่อกำหนดค่า Apache Solr

การปิดใช้การจัดทำดัชนีของ Google

และควรจัดทำดัชนีเนื้อหาและทำให้เครื่องมือค้นหาเข้าถึงได้ โดยค่าเริ่มต้น เครื่องมือจัดทำดัชนีของ Google จะจัดทำดัชนีเนื้อหา อย่างไรก็ตาม คุณเลือกปิดใช้การจัดทำดัชนีของ Google ได้ คุณอาจต้องการทำเช่นนี้หากพอร์ทัลนักพัฒนาซอฟต์แวร์ยังไม่พร้อมใช้แบบสาธารณะและไม่ต้องการให้ผู้ใช้ค้นหาเนื้อหาของคุณได้แบบสาธารณะ

วิธีปิดการจัดทำดัชนีของ Google

1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
2. เลือกโมดูลในเมนูการดูแลระบบ Drupal
3. เปิดใช้โมดูลเมตาแท็ก
4. คลิกบันทึก การกำหนดค่า
5. ในเมนูการดูแลระบบ Drupal ให้เลือก การกำหนดค่า > การค้นหาและข้อมูลเมตา > เมตาแท็ก
6. เลือกการดำเนินการลบล้างสำหรับประเภทส่วนกลาง
7. คลิกส่วนขั้นสูงเพื่อเปิด

   

8. ทำเครื่องหมายที่ช่องทำเครื่องหมายป้องกันไม่ให้เครื่องมือค้นหาจัดทำดัชนีหน้านี้
9. คลิกบันทึก

สังเกตว่ามีตัวเลือกอื่นๆ ที่เกี่ยวข้องกับเครื่องมือค้นหาในส่วน "ขั้นสูง" ของหน้าส่วนกลาง เช่น คุณเลือกช่องทำเครื่องหมายเพื่อป้องกันไม่ให้เครื่องมือค้นหาติดตามลิงก์ในหน้าเว็บได้ เลือกช่องทำเครื่องหมายเหล่านี้อย่างน้อย 1 ช่องตามความเหมาะสม

เอกสารวิธีลงทะเบียนแอป

เอกสารของคุณควรมีวิธีการลงทะเบียนแอปผ่านพอร์ทัลสำหรับนักพัฒนาแอปของคุณ คุณใช้วิธีการต่อไปนี้เป็นจุดเริ่มต้นได้ โดยคำแนะนำเหล่านี้จะครอบคลุมวิธีลงทะเบียนแอปผ่านพอร์ทัลเริ่มต้นสำหรับนักพัฒนาซอฟต์แวร์

หากต้องการกำหนดค่าวิธีที่นักพัฒนาซอฟต์แวร์ลงทะเบียนแอปในพอร์ทัลของคุณ โปรดดูการกำหนดค่าการลงทะเบียนแอปสำหรับข้อมูลเพิ่มเติม หากคุณปรับเปลี่ยนขั้นตอนการลงทะเบียนแอป ให้แก้ไขวิธีการตัวอย่างด้านล่างตามนั้น

วิธีลงทะเบียนแอปผ่านพอร์ทัลเริ่มต้นสำหรับนักพัฒนาซอฟต์แวร์

1. เลือกแอปของฉันใต้ชื่อผู้ใช้ในเมนูการเข้าสู่ระบบ
2. คลิกเพิ่ม (+) ไอคอนแอปใหม่

   

3. ป้อนค่าที่เหมาะสมในหน้าเพิ่มแอป

   ชื่อแอป	ระบุชื่อแอปที่ไม่ซ้ำสำหรับแอปของคุณ
   URL เรียกกลับ	หากจำเป็น ให้ระบุ URL เรียกกลับที่การเรียก OAuth กลับมา โดยค่าเริ่มต้น คุณต้องระบุค่านี้แม้ว่า API จะไม่ใช้ OAuth ก็ตาม หาก API ของคุณไม่ได้ใช้ OAuth ให้ป้อนค่าจำลอง เช่น my.site.com
   ผลิตภัณฑ์	เลือกผลิตภัณฑ์ API อย่างน้อย 1 รายการ.

4. คลิกสร้างแอปเพื่อลงทะเบียนแอปและสร้างคีย์ API สำหรับแอป