514 Commits

Author SHA1 Message Date
ryoku4 247ec64ba5 docs: correct "Github" to "GitHub" in multiple documentation files
Signed-off-by: ryoku4 <122875619+ryoku4@users.noreply.github.com>
2026-05-23 00:23:27 +09:00
Ben Lambert f0f6823a66 docs(scaffolder): update form decorators docs for promoted API (#34181)
* docs(scaffolder): update form decorators docs for promoted API

Signed-off-by: benjdlambert <ben@blam.sh>

* docs(scaffolder): address review feedback on form decorators docs

Signed-off-by: benjdlambert <ben@blam.sh>

---------

Signed-off-by: benjdlambert <ben@blam.sh>
2026-05-19 14:24:58 +02:00
Ben Lambert d09c21cb84 feat(scaffolder): config-driven template groups and swappable TemplateCard (#34147)
* feat(scaffolder): config-driven template groups and swappable TemplateCard

Signed-off-by: benjdlambert <ben@blam.sh>

* refactor(scaffolder): keep createGroupsWithOther internal

Signed-off-by: benjdlambert <ben@blam.sh>

* docs(scaffolder): fix sub-page extension ID in changeset

Signed-off-by: benjdlambert <ben@blam.sh>

* address PR review feedback

Signed-off-by: benjdlambert <ben@blam.sh>

* split TemplateCard swappable contract from legacy props

Signed-off-by: benjdlambert <ben@blam.sh>

* address review feedback: dedupe tags, defensive groups copy, doc clarifications

Signed-off-by: benjdlambert <ben@blam.sh>

* regenerate api reports

Signed-off-by: benjdlambert <ben@blam.sh>

* align docs and changeset with actual default group titles

Signed-off-by: benjdlambert <ben@blam.sh>

* regen api reports after rebase

Signed-off-by: benjdlambert <ben@blam.sh>

---------

Signed-off-by: benjdlambert <ben@blam.sh>
2026-05-12 12:29:44 +02:00
Ferin Patel 07e08beac1 feat: Add status check functions for scaffolder steps (#32890)
* feat: Add status check functions for scaffolder steps

- Introduced `always()` and `failure()` functions to control step execution after failures.
- Updated documentation to explain usage of new status check functions.
- Enhanced NunjucksWorkflowRunner to process these functions in step conditions.
- Added tests to verify behavior of steps using `always()` and `failure()`.

Signed-off-by: ferin79 <ferinpatel79@gmail.com>

* feat: Enhance status check functions in scaffolder steps

- Updated documentation to clarify usage of status check functions with template expressions.
- Modified tests to reflect changes in syntax for status checks.
- Refactored NunjucksWorkflowRunner to ensure proper handling of status check functions in step conditions.

Signed-off-by: ferin79 <ferinpatel79@gmail.com>

* docs: Clarify usage of status check functions in writing templates

- Removed redundant explanation about truthy conditions after step failure.
- Streamlined the description for better clarity on status check functions.

Signed-off-by: ferin79 <ferinpatel79@gmail.com>

---------

Signed-off-by: ferin79 <ferinpatel79@gmail.com>
2026-04-28 11:16:59 +02:00
Dmitry Gusev 3ef6078b70 scaffolder: Support conditional if on output links and text (#33332)
* Add sample template for conditional output demo

Add a scaffolder template that exercises conditional `if` on output
links and text items, for testing issue #24805.

Signed-off-by: Dmitry Gusev <gusevda90@gmail.com>

* Support conditional `if` on scaffolder output links and text

Add `if` property to output link and text items in scaffolder templates,
allowing template authors to conditionally show/hide output items based
on parameters or step results. Items with a falsy `if` condition are
filtered out before being sent to the frontend.

Signed-off-by: Dmitry Gusev <gusevda90@gmail.com>

* Add changesets for conditional output feature

Signed-off-by: Dmitry Gusev <gusevda90@gmail.com>

* Document conditional if on output links and text

Signed-off-by: Dmitry Gusev <gusevda90@gmail.com>

* Guard against non-object items in output arrays

Signed-off-by: Dmitry Gusev <gusevda90@gmail.com>

* Skip array items in output if-filtering destructuring

Add Array.isArray guard to prevent corrupting array items
into plain objects during the rest-destructuring step.

Signed-off-by: Dmitry Gusev <gusevda90@gmail.com>

* Extract filterConditionalItems helper to deduplicate logic

Signed-off-by: Dmitry Gusev <gusevda90@gmail.com>

* Align output if schema descriptions with step if semantics

Signed-off-by: Dmitry Gusev <gusevda90@gmail.com>

* Fix docs quality check: replace 'falsy' wording

Signed-off-by: Dmitry Gusev <gusevda90@gmail.com>

* Refactor filterConditionalItems to use flatMap and generics

Replace .filter().map() with a single flatMap call and make the function
generic to eliminate JsonArray casts at call sites.

Signed-off-by: Dmitry Gusev <gusevda90@gmail.com>

---------

Signed-off-by: Dmitry Gusev <gusevda90@gmail.com>
2026-04-14 14:29:04 +02:00
Patrik Oldsberg 9718e62c2d Merge pull request #33667 from backstage/docs-features-new-frontend-migration
docs: migrate feature documentation to new frontend system as primary content
2026-04-07 12:01:07 +02:00
Patrik Oldsberg 7f6b88783b docs: address review feedback on route refs, typos, and installation steps
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-04-04 16:15:01 +02:00
Patrik Oldsberg 18fde07e06 docs: address review feedback on code style in examples
Replace `Promise.resolve(...)` with `async` functions in scaffolder
FormFieldBlueprint.make examples, and switch the TechDocs custom home
page example to use the `plugin.withOverrides` pattern instead of
`createFrontendModule`.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-04-04 12:34:50 +02:00
Fredrik Adelöw bb7768ba06 docs: fix broken links and anchors across documentation
Fix ~30 broken links and anchors across the documentation site, including
incorrect relative paths, mismatched anchor names, zero-width characters
in URLs, and references to renamed or removed headings.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Fredrik Adelöw <freben@spotify.com>
2026-03-31 18:43:40 +02:00
Patrik Oldsberg 561f555fb1 docs: address copilot review feedback
Fix links in viewing-catalog.md and filter-catalog.md to point to
the new frontend system catalog-customization.md instead of the old
guide. Fix the Kubernetes entity content extension ID to use the
correct `entity-content:kubernetes/kubernetes` format. Wrap raw
extension definitions in `createFrontendModule` in search and
scaffolder docs. Correct TechDocs addon installation instructions
to explicitly install addon modules rather than claiming
auto-discovery.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-30 12:42:11 +02:00
Patrik Oldsberg c9132c223c docs: improve new frontend system docs for techdocs, scaffolder, and catalog
Expand the TechDocs home page customization section with concrete examples
showing how to override the page:techdocs extension using a frontend module.

Replace the incorrect scaffolder custom step layouts guide with a note that
this feature is not yet supported in the new frontend system.

Restore missing catalog customization docs for columns, actions, table
options, removing filters, and fully custom catalog pages to ensure parity
with the old frontend system guide.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-29 23:04:08 +02:00
Patrik Oldsberg 8ec254cd4b docs: migrate feature docs to new frontend system as primary content
Rewrite documentation for TechDocs, Software Templates, Software Catalog,
Search, and Kubernetes features to use the new frontend system as the
primary installation and configuration instructions. Old frontend system
instructions are moved to separate `--old` suffixed files for pages with
substantial legacy content, or updated inline for pages with minimal
old-system content.

Files migrated:
- techdocs/getting-started.md
- techdocs/how-to-guides.md
- software-templates/writing-custom-step-layouts.md
- software-templates/writing-custom-field-extensions.md
- software-templates/index.md
- software-catalog/catalog-customization.md
- search/getting-started.md
- search/how-to-guides.md
- kubernetes/installation.md

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-29 21:47:46 +02:00
Andre Wanlin 00617627b1 Merge pull request #33069 from awanlin/docs/scaffolder-clean-up
[Doc] Scaffolder clean up
2026-03-17 13:37:57 -05:00
Gabriel Dugny 49171c9de4 chore: Update all imports to zod/v3
Signed-off-by: Gabriel Dugny <gabriel.dugny@believe.com>
2026-03-17 16:48:42 +01:00
Andre Wanlin 765725c8c2 Fixed CI and addressed feedback
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-03-14 09:23:25 -05:00
Andre Wanlin ce8198bc15 Fixed link
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-03-14 09:23:25 -05:00
Andre Wanlin b35de8d2aa [Docs] Scaffolder Clean Up
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-03-14 09:23:25 -05:00
Ben Lambert e8736ea2e8 feat(scaffolder): implementing secrets schema for scaffolder templates (#32320)
* feat: implementing secrets schema for scaffolder templates

Signed-off-by: benjdlambert <ben@blam.sh>

* chore: fix and regenerate openapi
Signed-off-by: benjdlambert <ben@blam.sh>

Signed-off-by: benjdlambert <ben@blam.sh>

* chore: fix review feedback

Signed-off-by: benjdlambert <ben@blam.sh>

* fix: address code review feedback for secrets validation

- Extract validateSecrets helper to deduplicate validation logic
- Add auditorEvent.fail() call on secrets validation failure
- Sanitize instance field in error responses to prevent secret leakage
- Add retry endpoint test coverage for secrets validation
- Split changeset into per-package entries

Signed-off-by: benjdlambert <ben@blam.sh>

* refactor: nest secrets schema under secrets.schema

Move the JSON Schema definition from spec.secrets to
spec.secrets.schema to leave room for future extensions
like secret sources.

Signed-off-by: benjdlambert <ben@blam.sh>

* chore: update API reports

Signed-off-by: benjdlambert <ben@blam.sh>

* chore: use InputError for secrets validation audit event

Signed-off-by: benjdlambert <ben@blam.sh>

---------

Signed-off-by: benjdlambert <ben@blam.sh>
2026-03-10 11:47:40 +01:00
Andre Wanlin 1fdcfd563c Fixed link syntax
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-03-01 09:29:58 -06:00
Andre Wanlin 5142f60de3 [Doc] Removed Mentions of the New Backend System
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-02-28 11:22:02 -06:00
Jonathan Sundquist bd5b8426af feat(scaffolder): add new ui:options autoSelect tag (#32912)
* feat(scaffolder): add new ui:autoSelect tag

Signed-off-by: Jonathan Sundquist <jonathan.sundquist@factset.com>

* Update .changeset/long-hairs-throw.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Jonathan Sundquist <jsundquist@gmail.com>
Signed-off-by: Jonathan Sundquist <jonathan.sundquist@factset.com>

* Adding missing annotations in the schema file

Signed-off-by: Jonathan Sundquist <jonathan.sundquist@factset.com>

* Adding missing tests and documentation

Signed-off-by: Jonathan Sundquist <jonathan.sundquist@factset.com>

* adding in api report files

Signed-off-by: Jonathan Sundquist <jonathan.sundquist@factset.com>

* Fixing tests and ensure all required files have the necessary updates

Signed-off-by: Jonathan Sundquist <jonathan.sundquist@factset.com>

---------

Signed-off-by: Jonathan Sundquist <jonathan.sundquist@factset.com>
Signed-off-by: Jonathan Sundquist <jsundquist@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-19 08:19:38 +01:00
Andre Wanlin 6ce4a13bf4 docs - Writing Custom Actions Corrections
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-02-08 12:39:13 -06:00
aramissennyeydd efbf232bfa fix: update more /docs/references links
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
2026-02-04 10:11:36 -06:00
Patrik Oldsberg a21f50fc57 docs: apply minor fixes from feedback
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2026-01-30 11:36:09 +01:00
Aramis Sennyey 1e669ccd64 chore: migrate audit events docs to docsite (#32143)
* chore: migrate audit events docs to docsite

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* change headers

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* fix rebase conflict in sidebars.ts

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* correct sidebar

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

---------

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
2026-01-22 08:45:06 -07:00
Benjamin Janssens 49579170e9 refactor: remove coupling with form context
Signed-off-by: Benjamin Janssens <benji.janssens@gmail.com>
2025-12-16 09:49:35 +01:00
Benjamin Janssens 5ce3294f8d chore: fix typo; use correct variable
Signed-off-by: Benjamin Janssens <benji.janssens@gmail.com>
2025-12-15 15:55:53 +01:00
Benjamin Janssens ef1596f49a docs: add documentation
Signed-off-by: Benjamin Janssens <benji.janssens@gmail.com>
2025-12-11 16:59:36 +01:00
Rogerio Angeliski bf15d2a2ac docs: improve software template page
Signed-off-by: Rogerio Angeliski <angeliski@hotmail.com>
2025-10-09 10:38:04 -03:00
Vasil Shaikh e1d41e4519 docs(scaffolder): fix outdated CLI docs for backend-plugin-module
Signed-off-by: Vasil Shaikh <vasilshaikh24@gmail.com>
2025-08-17 03:11:25 +05:30
Fredrik Adelöw cdc0fa00d0 Merge pull request #30767 from deepthi-28/write_template
Minor documentation changes
2025-08-05 14:17:08 +02:00
Deepthi Ajith aa3baabc61 Minor documentation changes
Signed-off-by: Deepthi Ajith <deepthi.ajith@infosys.com>
2025-08-05 15:54:50 +05:30
copilot-swe-agent[bot] 2f940b0aec Address review feedback: simplify warning text and revert migration/custom action docs
Co-authored-by: Rugvip <4984472+Rugvip@users.noreply.github.com>
2025-07-16 17:46:02 +00:00
copilot-swe-agent[bot] ad56ea9417 Replace non-camelCase task IDs with camelCase equivalents
Co-authored-by: Rugvip <4984472+Rugvip@users.noreply.github.com>
2025-07-16 16:52:15 +00:00
copilot-swe-agent[bot] 1372ccfc0f Add prominent warnings about kebab-case action IDs causing NaN in scaffolder templates 2025-07-16 15:57:09 +00:00
Matt Benson 4e0b5fa14f templating extensions doc tweaks
Signed-off-by: Matt Benson <gudnabrsam@gmail.com>
2025-07-09 11:25:21 -05:00
Ben Lambert d95621b1ee Merge pull request #29202 from 04kash/scaffolder-task-granular-permissions
Scaffolder task granular permissions
2025-07-08 12:54:43 +02:00
gaelgoth c4a0830215 Remove 'allowedHosts' from Publish action input in template files
Signed-off-by: gaelgoth <gothuey.gael@gmail.com>
2025-07-04 07:58:40 +02:00
Łukasz Jernaś 3772e0c735 docs(scaffolder): Remove old JSON schema version from custom action
Signed-off-by: Łukasz Jernaś <lukasz.jernas@allegro.com>
2025-06-21 21:19:11 +02:00
Kashish Mittal ea4bdfa48e rename hasCreatedBy to isTaskOwner
Signed-off-by: Kashish Mittal <kmittal@redhat.com>
2025-06-18 16:25:06 -04:00
Kashish Mittal fe85d897d5 Remove hasTemplateEntityRefs and only keep hasCreatedBy
Signed-off-by: Kashish Mittal <kmittal@redhat.com>
2025-06-18 16:19:53 -04:00
Kashish Mittal c359d72cc2 update docs based on review comments
Signed-off-by: Kashish Mittal <kmittal@redhat.com>
2025-06-18 16:19:11 -04:00
Kashish Mittal bc3161292c modify docs related to scaffolder task permissions
Signed-off-by: Kashish Mittal <kmittal@redhat.com>
2025-06-18 16:19:11 -04:00
Andre Wanlin f7e7469944 Merge pull request #29899 from awanlin/docs/remove-prettier-ignore-comment
Removed unneeded `# prettier-ignore` comment in docs and blog files
2025-06-11 08:50:59 -05:00
Andre Wanlin b5545900a4 Initial removal
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2025-06-06 13:14:54 -05:00
Dominika Zemanovicova 023629e0b4 Render secrets in each
Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>
2025-06-03 13:07:37 +02:00
Andre Wanlin e54ef16c28 Merge pull request #29888 from kmarkow/docs-template-examples
Update docs on TemplateExamples and how to test them
2025-05-13 07:51:29 -05:00
Kamil Markow fe3991af73 Update docs/features/software-templates/writing-custom-actions.md
Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
Signed-off-by: Kamil Markow <kamilmarkow@gmail.com>
2025-05-12 11:28:52 -04:00
Kamil Markow 5e3880c6ef Update docs/features/software-templates/writing-custom-actions.md
Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
Signed-off-by: Kamil Markow <kamilmarkow@gmail.com>
2025-05-12 11:28:40 -04:00
Kamil Markow e085771461 Update docs on TemplateExamples and how to test them
Signed-off-by: Kamil Markow <kamilmarkow@gmail.com>
2025-05-08 11:43:24 -04:00