Blog

platformOS Documentation and UX Status Report — July 22, 2019

UPDATES
STATUS REPORT
DOCUMENTATION
UX
In this week’s status report: new community section, UX improvements based on our user research, fixes and updates.
platformOS Documentation and UX Status Report — July 22, 2019

Documentation


Content production

  • NEW Community section: We have added a Welcome page to our community section that includes a collection of ways to contribute to our documentation, a list of channels to talk to us and other community members, and ways to stay up-to-date with our development and documentation. We also  reorganized this section to include our updated Contributor Guide and Documentation Style Guide.

Improvements, fixes



UX

Research

  • Onboarding strategy: As a result of the onboarding research, we put focus on updating the welcome page of pOS Instances. The goal is to provide users some help to move forward with a newly created instance. Besides that, we also created a new layout for the 1-Click Demo Instance Creator.

Design and Development

  • IN REVIEW Update the commands cheat sheet: in Partner Portal to use pos-cli
  • IN REVIEW Data import: batch import performance improvements
  • IN REVIEW Improve ux of related models query by providing meaningful feedback when invalid arguments are provided (foreign key, related model schema name)
  • IN REVIEW Use pos-cli for module deployment
  • IN REVIEW  Template for module resources - Create / Edit module screen The template provides an outline of content to include on the create module page resources section (previously called Description, Documentation, and Support).
  • IN PROGRESS token per Instance instead of one global token
  • IN PROGRESS New look and content for the pOS Instance Welcome Page
  • IN PROGRESS New look and content for the pOS 1-click demo Instance creator page
  • IN PROGRESS Screen flow diagrams were created to identify user flows related to billing processes.

Improvements, fixes

  • NEW improve ux of form_submit: explicit “id” argument was added as an alternative option to determine which resource to update. It could be useful when you want to update the current user. 


Release notes

Please check out our latest release notes of 22 July, 2019: improved liquid array/hash output, slight page routing improvement

Interested in knowing more about partnering with platformOS?

Ensure your project’s success with the power of platformOS.