APK Doc Structure Phase 1

[Mariangela]

Description:
Finalize the doc structure for the initial set of APK docs.

[Mariangela]

The following were the participants in the APK doc structure meeting on the 20th Oct

• Mariangela Hills
• Nandika Jayawardana
• Pubudu Gunatilaka
• Samuel Gnaniah
• Sanjeewa Malalgoda
• Tharindu Dharmarathna
• Isuru Udana
• Nuwan Dias

The following was decided.

• Change the proposed doc structure based on the new regrouping of "Develop and Deploy API" and "Manage API"
• It was decided to first focus on the latter two sections and the Getting Started section as the 1st cut.

[1] V1 - https://docs.google.com/document/d/1fjp70ydrkvOccwfWT1MUurOZ12Lf6RYCmblUXxBvreI/edit#

[Mariangela]

Was on leave on the 24th hence this task was on hold that day.

[Mariangela]

Had a meeting with Isuru Wijesiri on the 25th to get more clarity on the Runtime UIs and functionality.

[Mariangela]

Had a meeting with Piyumal Kularathna on the 25th to get more clarity on the Back-office UIs and functionality.

[Mariangela]

The following were the participants in the APK doc structure v2 meeting on the 31st Oct

• Nuwan Dias
• Sanjeewa Malalgoda
• Mariangela Hills
• Amali Matharaarachchi
• Samuel Gnaniah
• Tharindu Dharmarathna
• Ruthryi Kulasekaran
• Nandika Jayawardana

The following was decided.

• The captions "Develop and Deploy API" and "Manage API" should maintain the word "APIs" at the end for clarity.
• The sections that were highlighted in Cyan was kept to discuss later after the initial cut of the discussed structure is implemented.
• The current structure that was finalised for the Get Started, "Develop and Deploy API" and "Manage API" in v2 [2] need to be implemented.
• Communicate the changes that were discussed in the Managed API (Backoffice API) workflow to Piyumal Kularathna - This was communicated by Mari.

[2] V2 - https://docs.google.com/document/d/1Mbmc9Qry1mHa4QModfWEWvP8c0Dd_iWBTOb44O7DmRI/edit#heading=h.of4jcftlpne3

[Mariangela]

As phase 1 of this task has been completed, I am closing this issue.

[Mariangela]

Update on 5th Jan
Further to the discussion that I had with Sanjeewa, he wanted us to consider revamping the V2 doc structure after throughly getting an understanding on APK.

• He said that the documentation needs to be very simple and lightweight similar to testkube
• He said to consider the following competitor docs.
  • Tyke
  • Ambassador

[Mariangela]

The following were the participants in the APK doc structure v3 meeting on the 2nd Feb

• Mariangela Hills
• Amali Matharaarachchi
• Amila Senadheera
• Krishan Wijesena
• Pubudu Gunatilaka
• Ruthryi Kulasekaran
• Sampath Rajapakshe
• Sanjeewa Malalgoda
• Tharindu Dharmarathna
• Nilmini Perera
• Samuel Gnaniah

This [1] is the high-level structure (V3) that was proposed to the APK team and [1] was updated based on the points discussed at the meeting. Further, streamlining will be done.

[1] V3 - https://docs.google.com/document/d/1j2BT7vHZ-YqnuE2fLaULckDfNFG4akq-PYsvNdFi1XA/edit#heading=h.nvfgg01f6xne