Blog

platformOS Documentation and UX Status Report — July 15, 2019

UPDATES
STATUS REPORT
DOCUMENTATION
UX
Check the new Best practices section, read the latest Release notes and get familiar with the new items of the renaming initiative and the updates of the onboarding research and more info about the Documentation and UX updates in our post.
platformOS Documentation and UX Status Report — July 15, 2019

Documentation

Content production

  • NEW Best Practices: We have added a new section to our documentation based on your feedback, where we collect articles and tutorials showing you platformOS development best practices, tips and tricks in a wide variety of topics, including code quality, development workflow, performance, testing, and QA. 
  • NEW Identity Providers
  • NEW Auth0 Integration 
  • NEW Google Auth Integration
  • NEW Facebook Integration
  • UPDATED Footer: We re-organized and updated the footer to include links to all major areas of the site (plus external links to the blog and status reports) in an easier to use structure. 
  • NEW Renaming updates: We renamed Customization to Model, CustomModelType to ModelSchema, and marketplace-kit to pos-cli —  we updated all topics and examples in the documentation to use the new naming. 
  • UPDATED Get Started: First quick re-organization done, planning more in-depth changes for the new Get Started section (whole scenario). 
  • UPDATED How platformOS Works: Updated landing page to direct attention to sidebar navigation. 
  • UPDATED Partner Portal Tutorials navigation: Grouped tutorials into categories (Users, Instances, Domains, Billing Plans) for easier use.   
  • UPDATED resource_type in examples: Updated all examples to make sure we recommend the simplest way possible to reduce the learning curve.

Improvements, fixes

  • FIXED GitHub Contribution links on topics were broken, now fixed

UX

Research 

  • Onboarding strategy: We are continuously evaluating the stories you shared about your onboarding experience. Based on these feedbacks, it emerged that it would be useful for you to be able to follow how the platform is evolving, therefore as a next step, we included the creation of release notes in the development process.
    Other than that, we continued the renaming process and added new items to the Get started section based on your feedback.

Design and Development

  • NEW Notification emails after module usage for module creators As a module creator you can receive emails related to the following topics: set scope for a module, rejected module version, module purchase, module unsubscription, after each failed deployment
  • NEW Notification emails after module usage for module users As a module user you can receive emails related to the following topics: module installation, new module version released, after new version deployed, after each failed deployment.
  • NEW Notification emails for module subscriptions Related to subscribed module payments, users can receive the following notifications: The price of the scheduled payments 1 week before payment,  Summary email about prices 10 mins before payment, Failed payment related to subscribed modules. Successful payments are listed in the statements screens.
  • NEW Notification emails for module with one-time fee Related to a module with a one-time fee, users receive emails if the payments failed. Successful payments are listed in the statements screens.
  • NEW Edit screen for module versions: You can access this screen via the module settings screen in the list of module versions. It makes it possible to edit the release notes of the module versions. 
  • IN PROGRESS OAuth2 flow for deployment tokens
  • IN PROGRESS Improve ux of related models query by providing meaningful feedback

Improvements, fixes

  • IN REVIEW Fix the appearance of the license description

Release Notes

To learn more about the most recent changes, improvements and fixes in platformOS, check out our latest release note: platformOS Release Note, July 15, 2019 — pos-cli, new graphql mutation - form_submit.


Interested in knowing more about partnering with platformOS?

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