Documentation

Article: Building Our Documentation Site on platformOS — Part 4: Implementation

We have published the final part in our series about how we built our documentation site where we have discussed our process from discovery to implementation. This part discusses Instances, pages, layouts, docs as code, how we implemented contribution through GitHub and our auto-generated API reference, and more. We also included an in-depth exploration of how we have achieved a 100/100 Google Page Speed Insights score with lots of useful tips and resources to improve the performance of your platformOS site.

Content production

• NEW Best Practice — Performance: Lazy Loading of Fragments
• UPDATED Roadmap: We have fully separated past feature implementations from future plans. From now on, our roadmap shows features we are planning to implement half a year ahead. Once we implement a feature or enhancement, we check its checkbox and link to the respective release note for you to be able to learn more about it, and find related examples and documentation topics. All past feature implementations, improvements and fixes have been moved to our release notes. 
In parallel, we removed individual roadmap pages from our search results, only the main roadmap page is indexed for search.
• UPDATED Liquid Tags: Loops - added forloop.parentloop

• PLANNED Add topic: Module Translations 

• PLANNED Best practices are very hard to discover

• PLANNED Check and update GraphQL mutation admin_model_schema_create

• PLANNED Add topic: Using GraphQL in platformOS 

• PLANNED Update topic Form Configurations - async callback actions

• PLANNED Update Identity Providers topics

Improvements, fixes

• UPDATED Improved the formatting of platformOS Liquid tag parameters
  
  

UX

Research

• pOS Developer Experience Research - Interview: We are running the Developer Experience Research until the end of January if you are interested you can still subscribe via this link.

Design and Development

• NEW Partner Portal - Module Marketplace detail page wireframes
• NEW Powered by platformOS logo
• NEW pOS logos for Certified partners Certified Partners
• NEW Allow dashes in endgraphql
• NEW Remove page format or accept headers
• NEW Fix edge case error when installing a module
• NEW Fix serializing user attributes
• NEW Ensure pos-cli deploy works with both -d -p flags
• NEW Added error codes to forms
• NEW Added belongs to graphql property
• NEW Added metadata to graph queries
• NEW Email uniqueness scoped to deleted at
• NEW Added value for other types than string for properties
• NEW Deprecated transactable_* mutations
• NEW Admin assets should be public
• NEW Fix sorting by updated_at in admin_query
• NEW Improve handling of low level database error
• IN REVIEW Partner Portal - DNS API expose domain destroy function
• IN PROGRESS Hard delete job with 30 days time delay
• IN PROGRESS Partner Portal - Implementation of the Non-Technical onboarding journey
• IN PROGRESS Allow to export/import raw id instead of external_id

Improvements, fixes

• NEW Fixed jwt_decode_and_set_session as it does not set current_user in context.current_user
• NEW Added an error message in instance logs when wrong data is submitted to an API endpoint
• NEW Fixing attachments: direct URL
• IN PROGRESS Image export and import

Release Notes

To learn more about the most recent changes, improvements and fixes in platformOS, check out our latest release notes:

• platformOS Release Note Dec 30, 2019 — Respect Content-Type header when rendering page, GraphQL improvements
• platformOS Release Note Jan 13, 2020 — Error handling and GraphQL fixes