Documentation

Content production

• IN PROGRESS Best Practices: We have started working on the new section we planned, Best Practices. In this section, we collect articles and tutorials from experienced platformOS developers in a wide variety of topics, including code quality, development workflow, performance, testing, and QA. The first phase of this project (creating the section, navigation, first batch of topics) is in review, and we have started working on the second phase (more content, more in-depth articles). 

• IN PROGRESS Renaming updates: We are updating our documentation in parallel with renaming directories in our codebase based on the results of our UX research. 

• IN REVIEW Get Started updates: We are updating our Get Started section as part of the UX & doc improvements of our onboarding based on your feedback. This is one of the many steps we’re planning to iteratively improve our onboarding experience. The Quickstart Guide and the Get Started section will be further separated, where the Quickstart Guide will describe the 1-Click Install process, and the Get Started section will walk you through the process in detail. 

• IN REVIEW How platformOS Works updates: We are updating the landing page of this section to make it easier to use and to direct the attention of the user to the sidebar navigation. 

• UPDATED Custom Addresses — added information about the field structure and validation details for long and lat fields. 

• PLANNED Documentation on using Auth0 

• PLANNED Part 2 of Code Quality and Performance Best Practices article 

• PLANNED Add Marketplace gui info to the Get Started guide

• PLANNED Add information about Form Callbacks to documentation

Improvements, fixes

• FIXED Colors for the Warning and Important alerts were switched, now fixed
• IN PROGRESS Contribution links are broken on the Doc site
• PLANNED Split up icons sprites
• PLANNED Research if sass can be removed in favor of postcss plugins

UX

Research

• Onboarding strategy: We are continuously evaluating the shared stories about your onboarding experience and as a result of that we collected new topics to document and will focus on the 1-Click Instance creation process which can work as a Sandbox to try out pOS possibilities.

Design and Development

• NEW Direct assets upload via graphql mutations `admin_assets_create` and `admin_assets_presign_urls`
• NEW Run `marketplace-kit audit` during deploy and notify users about any warning.
• IN REVIEW Notification emails for module subscriptions
• IN REVIEW  Notification emails after module usage: Email templates for the end of the module unsubscription period. Related to this we modify the screens of the create and edit module screens.
• IN REVIEW Edit screen for module versions: through this screen users can edit version numbers and release notes
• IN REVIEW `form_submit` mutation was added to graphql: This new mutation will trigger form submission along with invoking authorization policies and validation. It accepts two parameters: `form_configuration_name` and `params`. This way you will be able to easily validate any user parameters against a given form configuration and save the user input if valid. Very useful for creating API endpoints that re-use existing form configurations.
• IN PROGRESS OAuth2 flow for deployment tokens

Improvements, fixes

• FIXED `join-on-property` and `foreign-property` works with `self-properties` (id email, user-id etc.)