Documentation
Reorganization
Based on your feedback we received through user research, Slack, our feedback block, in Town Halls, etc., we are reorganizing content and navigation on our documentation site. In the first round, we made the following changes:
- We renamed the Tutorials section to Developer Guide. This reflects our plan to extend our tutorials in this section with more concept/rules topics as requested. Our plan is to have a comprehensive Get Started section for beginners with the Hello, World! tutorial and the Build a ToDo List App series, and the Developer Guide for everyone working with platformOS from users who have just finished the Get Started guides to experienced platformOS developers.
- We removed the How platformOS Works section and moved the topics it previously included into the Introduction category of our Developer Guide.
- We reorganized the main menu, which now includes Get Started, Developer Guide, API Reference, Best Practices, Use Cases.
- We reorganized the home page cards and other content to reflect the new structure and highlight the Release Notes and the Community section.
- We reorganized the footer.
In the next round, we are planning to add more concept/rules topics to the Developer Guide, reorganize categories in the Developer Guide as needed, and improve UX, for example for the feedback block.
Article featured on Docs Like Code
Part 4 of our article series about building our documentation site has been republished on Docs Like Code.
Content production
UX
Design and Development
- NEW pOS Marketing Site - About us and Contact us page designs and layout for the Developers and Partners pages
- NEW Unify current_user and context.current_user
- NEW Fast export on new stack
- IN REVIEW Builder: migrate data when property type changes
- IN REVIEW Fix deploy without assets
- IN REVIEW Allow to pick algorithm for jwt token
- IN PROGRESS Postgres: set timeout for queries
- IN PROGRESS Revive and improve pos-cli export
- IN PROGRESS Respect full graphql query/mutation path during sync/deploy
- IN PROGRESS Make name attribute in form optional (default based on path)
- IN PROGRESS Duplicate instance to any stack, including data and assets
- IN PROGRESS Split Scope for queries on large model collections
Improvements and Fixes
- IMPROVED asset_url will always render a full path to file hosted in CDN, even if it does not exist in the manifest
- FIXED static_cache expire config in Page will cache Page for given time
- FIXED match filter error handling for invalid expression
- FIXED presign url - fix for path with spaces and other special characters
- FIXED deprecated current_user will return the same hash as recommended context.current_user to avoid unexpected errors
- FIXED asset_url will correctly decode the name before looking it up in the manifest
- FIXED removed legacy routes to correctly display 404 if the Page does not exist (internal error was returned instead for some edge cases like /webhooks)
- IN REVIEW Liquid: match filter fix for invalid expression
- IN REVIEW Graphql: presign url - fix for path with spaces
Development
To learn more about the most recent changes, improvements and fixes in platformOS, check out our latest release note: platformOS Release Note Mar 2, 2020 — Fixes and improvements