JSONata and XML APIs in the Scaffolder, clarification in Support Guidelines, markdown in HTML for TechDocs, private images on the README card
Happy new year! Welcome to Roadie in 2023, packed with new features:
- You now have 6 new actions available in the Scaffolder to do more with JSON and YAML files in your templates.
- You can now embed markdown within an HTML snippet in your TechDoc files and see images stored in a private repo in their corresponding README card and Markdown homepage card.
- Also, we’ve updated the Support Guidelines for Growth Plan customers.
You can now make more sophisticated manipulations when using JSON and Markdown files in your Scaffolder templates. We’ve enabled some actions that let you serialize, process, and transform JSON and YAML files using the JSONata syntax.
You can find details on how to use the new actions under your
Scaffolder > Installed Actions page (find it under the Three-dots Context menu at the top right in the Create page). These are the actions you’re looking for:
Additionally, we’ve added support for XML API calls in the
http:backstage:request action. Below is an example:
steps: - id: xml-request name: Send XML request to service action: http:backstage:request input: path: '/api/proxy/foo', method: 'POST', body: '<?xml version="1.0" encoding="UTF-8"><node>asdf</node>'
For customers in the Growth Plan, we’ve specified how we handle prioritization and outlined what is not covered in the plan’s included support. Mainly, we clarify that helping customers write their software templates is out of the scope of Roadie’s Goalie.
We want our customers to be successful, so if you are in need of help beyond the Guideline specified scope, reach out to us on Slack or to [email protected] to request additional support services.
You can find the updated Support Guideline in your Slack channel if your team is on a Growth Plan.
You can now nest markdown in HTML blocks within your TechDocs files. A common use-case for this feature is when you have a collapsable section in your docs, and you want to use markdown within those sections instead of having to continue with HTML. For example:
<details markdown="1"> <summary>Collabsable Title</summary> Content of the collapsable and an image below ![asdf](align.jpg) </details>
Learn more about what you can do with TechDocs in our documentation.
Previously, if you referred to an image of a private repository, you’d get a 404 in the README card and the Markdown Homepage card. Now, you’ll correctly see images from the private repo displayed in both places. Previously, if you referred an image of a private repository, you’d get a 404 in the README card and the Markdown Homepage card. Now, you’ll correctly see images from the private repo displayed in both places.