Commit Graph

222 Commits

Author SHA1 Message Date
Thomas Cardonne 8d30688534 docs(software-templates): document new template output format
This format has been deprecated and users should use links instead

Signed-off-by: Thomas Cardonne <thomas.cardonne@adevinta.com>
2022-07-15 10:50:38 +02:00
Ben Lambert 5a98712ce3 Merge pull request #11806 from dotressel/add-allowed-repos-to-repourlpicker
Scaffolder: RepoUrlPicker: Add allowedRepos Option and move RepoName Input to own Component
2022-06-29 16:00:06 +02:00
Vladimir Masarik fccddd80fd docs: fix prettier complaints
Signed-off-by: Vladimir Masarik <vladimir.masarik@ef.com>
2022-06-20 17:43:44 +02:00
Vladimir Masarik e81be86682 docs: fix template typos
Signed-off-by: Vladimir Masarik <vladimir.masarik@ef.com>
2022-06-17 16:02:15 +02:00
Vladimir Masarik a6321c9b9f docs: writing templates, add examples of how to use values
Add information on how to actually use the parameters from the UI in the actual code
so that users can fully utilize the templating power of the default templating
action.

Signed-off-by: Vladimir Masarik <vladimir.masarik@ef.com>
2022-06-17 15:25:17 +02:00
Vladimir Masarik 7fc1f50f57 docs: Adding templates, added note for users that they need to refresh the location
Othwise, backstage won't display the updated or newly added template,
and it won't report any errors either.

Signed-off-by: Vladimir Masarik <vladimir.masarik@ef.com>
2022-06-17 15:24:46 +02:00
Vladimir Masarik 4ae8c4b0b7 docs: Adding templates, add template as a file example
Signed-off-by: Vladimir Masarik <vladimir.masarik@ef.com>
2022-06-17 14:49:43 +02:00
Vladimir Masarik 1ee1a02d67 docs: custom template actions update code exmaple
Users don't need the container runner, and variables have to
be passed in differently

Signed-off-by: Vladimir Masarik <vladimir.masarik@ef.com>
2022-06-17 14:40:22 +02:00
Vladimir Masarik 7e35d62a13 docs: custom tempalte actions clearly express that the builtin actions are replaced
Signed-off-by: Vladimir Masarik <vladimir.masarik@ef.com>
2022-06-17 14:40:22 +02:00
Maixmilian Ressel 557072e19b change some capitalizations
Signed-off-by: Maixmilian Ressel <maximiliandotressel@gmail.com>
2022-06-16 12:43:32 +02:00
Maixmilian Ressel 2de3fc3231 Add documentation for allowedOwners and allowedRepos
Signed-off-by: Maixmilian Ressel <maximiliandotressel@gmail.com>
2022-06-15 17:18:44 +02:00
Maixmilian Ressel 85f2d90543 docs: scaffolder: improve docs to setup the RepoUrlPicker authentication
Signed-off-by: Maixmilian Ressel <maximiliandotressel@gmail.com>
2022-06-14 16:30:24 +02:00
blam 79c8e5c586 chore: added doc updates for user templating
Signed-off-by: blam <ben@blam.sh>
2022-06-13 13:59:46 +02:00
Patrik Oldsberg 115f6452bf scaffolder: form data fixups
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-05-19 17:09:48 +02:00
Johan Haals c29997a0ee Merge pull request #11513 from arhill05/master
Add Git actions to Plugins Marketplace
2022-05-19 14:04:53 +02:00
Minh Trí 86a4a0f72d [Scaffolder] Get data of other fields in Form from a custom field
Allows to use e.g.
```
const CustomFieldExtensionComponent(props: FieldExtensionComponentProps<string[]>) => {
     const { formContext } = props;
     ....
};

const CustomFieldExtension = scaffolderPlugin.provide(
  createScaffolderFieldExtension({
    name: ...,
    component: CustomFieldExtensionComponent,
    validation: ....
  })
);
```

Signed-off-by: Minh Trí <tritri251214@gmail.com>
2022-05-19 15:13:55 +07:00
Drew Hill 9849722e1a Add Git actions to Plugins Marketplace
Signed-off-by: Drew Hill <andrew.hill@e-farmcredit.com>
2022-05-13 11:47:03 -04:00
Lovie 86b0909e25 Updated documentation to rename plugin
Documentation was not up to date with master codebase where plugin has been renamed to scaffolderPlugin

Signed-off-by: Lovie <lovie.minhas@gmail.com>
2022-04-21 09:19:13 +01:00
Gediminas dd131d95be docs: update custom field extensions writing guide
Signed-off-by: Gediminas <gediminasgn@gmail.com>
2022-03-25 10:25:46 +01:00
daftgopher bd4aac9c80 additional template migration documentation
Signed-off-by: daftgopher <daftgopher@users.noreply.github.com>
2022-03-19 17:15:32 -04:00
Marco Crivellaro e0308ca6ec replacing workflow:write scope with workflow, workflow:write is invalid.
Signed-off-by: Marco Crivellaro <marco.crive@gmail.com>
2022-03-16 17:19:26 +00:00
Fredrik Adelöw 6565f2c50b Merge pull request #10147 from rex4539/typos
Fix typos
2022-03-15 11:01:46 +01:00
djamaile 41f51ad5d5 docs: write on how to use feature flags within templates
Signed-off-by: djamaile <rdjamaile@gmail.com>
2022-03-14 19:06:32 +01:00
Fredrik Adelöw 18b03f031b Merge pull request #10150 from backstage/freben/plugin-head
make the backend plugin ts files consistent
2022-03-14 11:04:07 +01:00
Johan Haals 78e95df160 Merge pull request #9918 from RoadieHQ/add-new-actions
Add link to new actions
2022-03-14 09:46:07 +01:00
Fredrik Adelöw 89c7e47967 make the backend plugin ts files consistent
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-03-13 19:27:46 +01:00
Dimitris Apostolou aedd4daa66 Fix typos
Signed-off-by: Dimitris Apostolou <dimitris.apostolou@icloud.com>
2022-03-13 14:12:05 +02:00
blam 6049d33313 chore: updating this in documentation though too
Signed-off-by: blam <ben@blam.sh>
2022-03-09 10:08:50 +01:00
blam 5625443a26 chore: added a note in the migration sheet
Signed-off-by: blam <ben@blam.sh>
2022-03-08 15:07:41 +01:00
blam 592ac178ec chore: updating documentation and removing the last of v1beta2
Signed-off-by: blam <ben@blam.sh>
2022-03-08 14:26:03 +01:00
Kiss Miklos 9135b66f32 add links to new roadie actions
Signed-off-by: Kiss Miklos <miklos@roadie.io>
2022-03-02 19:16:37 +01:00
Luna Stadler 33ae7f244b Fix header nesting in software-templates docs
Most pages in the 'Software Templates' docs seemed to have one level too
much nesting.  This fixes that.  Without the correct nesting, the table
of contents on the right side was also missing and made reading the
longer pages (e.g. writing-templates) more difficult to read.

What's odd is that when rendering with `mkdocs` locally the nesting
seems to be okay and the table of content renders.

Pages affected live:

- https://backstage.io/docs/features/software-templates/software-templates-index
- https://backstage.io/docs/features/software-templates/configuration
- https://backstage.io/docs/features/software-templates/writing-templates
- https://backstage.io/docs/features/software-templates/builtin-actions
- https://backstage.io/docs/features/software-templates/writing-custom-actions

https://backstage.io/docs/features/software-templates/adding-templates
is okay because it has no subheadings.

And these two are okay because they have correct nesting starting at
level two (`##`):

- https://backstage.io/docs/features/software-templates/writing-custom-field-extensions
- https://backstage.io/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3

Signed-off-by: Luna Stadler <luc@spreadshirt.net>
2022-03-01 11:50:47 +01:00
Kiss Miklos 4610dab453 Make header more readable
Signed-off-by: Kiss Miklos <miklos@roadie.io>
2022-02-10 17:08:19 +01:00
Kiss Miklos 17240b1c17 run prettier on changed file
Signed-off-by: Kiss Miklos <miklos@roadie.io>
2022-02-10 16:52:58 +01:00
Kiss Miklos 4a3386a35c remove accidental change
Signed-off-by: Kiss Miklos <miklos@roadie.io>
2022-02-10 16:17:41 +01:00
Kiss Miklos 1c6825d88a add missing step to docs
Signed-off-by: Kiss Miklos <miklos@roadie.io>
2022-02-10 16:13:28 +01:00
blam 37a3fc75c0 chore: more code review fixes
Signed-off-by: blam <ben@blam.sh>
2022-02-01 09:02:32 +01:00
blam b856b156c2 docs: making the docs a little clearer
Signed-off-by: blam <ben@blam.sh>
2022-02-01 09:02:32 +01:00
blam c95df1631e chore: added changeset and updating documentation about being able to grab the user token
Signed-off-by: blam <ben@blam.sh>
2022-02-01 09:02:32 +01:00
Patrik Oldsberg 9e3a06f09f Merge pull request #8983 from alefcarlos/feat/plugin-dotnet-backend
feat: added backend .NET scaffolder plugin
2022-01-26 18:43:33 +01:00
Alef 3847c6f7a7 docs: prettier
Signed-off-by: Alef <alef.carlos@gmail.com>
2022-01-25 14:20:57 -03:00
Erik Aaron Hansen 8e09fc712e Update writing-custom-actions.md
Signed-off-by: Erik Aaron Hansen <erikaaron.hansen@technipfmc.com>
2022-01-24 13:51:30 +01:00
Alef e50ddb1f72 docs: better naming
Signed-off-by: Alef <alef.carlos@gmail.com>
2022-01-20 17:06:56 -03:00
Alef 75883ddf32 docs: added to custom actions doc
Signed-off-by: Alef <alef.carlos@gmail.com>
2022-01-18 09:48:11 -03:00
goenning 01e1f746f1 update docs
Signed-off-by: goenning <me@goenning.net>
2021-12-17 15:10:48 +00:00
Johan Haals e3d21acf2a Merge pull request #8374 from backstage/orkohunter/docs-v1beta3-templates
scaffolder: update docs with v1beta3 syntax
2021-12-08 14:13:41 +01:00
Himanshu Mishra 285f7ec2e6 fix apiVersion for scaffolder.backstage.io/v1beta3 in docs
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-12-07 18:13:06 +05:30
Tim Hansen 36bb4fb2e9 More scaffolder config cleanup
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-12-06 13:13:03 -07:00
Himanshu Mishra 94c3583f2b scaffolder: update docs with v1beta3 syntax
migration guide: https://backstage.io/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3

Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-12-06 11:23:16 +05:30
Johan Haals 972a047c43 microsite: close html tags
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2021-12-03 11:34:06 +01:00