Microservices: Clarity Needed On Several Topics

Description

There are several topics within the Microservice section that require clarification or rewriting. Considering the inherent technical abilities of anyone seriously reading this section, providing more comprehensive and accurate copy will improve the developer experience.

Current Content

Limitations Page: https://developer.trackvia.com/microservices/limitations

FAQs Page: https://developer.trackvia.com/microservices/faq

Proposed Changes

1. Duplicate Limitations Page vs FAQs - There is a standalone limitations page, however there is also a limitations sub-section on the FAQs page. Although redundancy in this context is low risk, the fact pattern between both sets of content are conflicting (e.g. runtime and memory limits). Thus, these should be reconciled into one section followed by an accuracy review by TrackVia's engineers.
2. More Information on Runtimes - Microservices are stated to support Node and Python, however there are no details on the process to switch from the default Node runtime to Python. Excluding a self-service API endpoint or some other automated system to detect the language used in an uploaded Microservice, a section outlining the process of requesting the switch through support should be created. This will ensure that the developer does not erroneously upload a Python Microservice if there is no automated/self-service manner to initialize it.
3. Reference to Security Policies - On the FAQs page, there is a reference to TrackVia's security policies. Considering the technical and legal risk profile of Microservices, a direct link to these policies should be created or embedded directly on the page.
4. Git Repo for Formstack Merge Example - The current ZIP offering for this example is fine, however there is value to a developer to have it in a Git repo where additional issues/comments/documentation can exist in a transparent nature. This ultimately would require more resources from TrackVia, e.g. to maintain that repo and allocate engineering resources to answering questions, however I believe that it could evolve into a useful resource for those new to the TrackVia ecosystem. Furthermore, it will provide TrackVia with a low-risk place to test the waters on community interactions, with the intent of developing a governance framework for the future Developer Community.
5. Link Back to the OpenAPI Documentation - It is technically possible to list and invoke Microservices via the OpenAPI. This is not explained in explicit detail yet, which presents an opportunity to link to the OpenAPI documentation (https://developer.trackvia.com/api-development/swagger).