question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[scaffolder] Link to documentation of a template if it exists in TemplateCard

See original GitHub issue

I’ve created documentation for a template (just local dev for now), and it’d be nice if that doc would be linked from http://localhost:3000/create/

Feature Suggestion

Add link to documentation for scaffolder templates. This would help in cases where you want to share more context about what a template would be good for. Say you have a few dashboard templates, and you want to explain to a data science engineer which to use.

Possible Implementation

Similar to the VCS source location, optionally link to the documentation of a template in TemplateCard.

Context

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:10 (7 by maintainers)

github_iconTop GitHub Comments

2reactions
benjdlambertcommented, Sep 22, 2022

I actually think that this has been done over here in https://github.com/backstage/backstage/pull/13662

0reactions
frebencommented, Sep 26, 2022

Alright, closing as fixed for now!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Writing scaffolder templates - Roadie.io
The Roadie Backstage scaffolder is a feature that allows you to define software templates to create new software projects, update existing ...
Read more >
[RFC] Next Steps for the Scaffolder · Issue #2771 - GitHub
Running on existing repositories, or code that exists and creating PR's for the changes; Composing templates together (#docs-as-code) ...
Read more >
Writing Templates · Backstage Software Catalog and ...
Templates are stored in the Software Catalog under a kind Template . You can create your own templates with a small yaml definition...
Read more >
Hidden Data - Scaffolding Forms & Templates for Confluence ...
Hides its contents when the page is being viewed, but allows it to be modified when editing. Parameters. Name, Required, Available In, Migratable...
Read more >
User-Guide - Downloading templates - Ploomber documentation
Click on the template link to see the source code on GitHub. ... If no template suits your needs, use the ploomber scaffold...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found