paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 24 Packages Projects Releases Wiki Activity
23,943 Commits 1 Branch 0 Tags
74663277fb371b01e989e08bc33a352b93ac2930
Commit Graph

191 Commits

Author SHA1 Message Date
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
jrusso1020 f3bcd52216 rename swimlane -> group 
Signed-off-by: jrusso1020 <jrusso@brex.com>
 2021-11-27 12:36:29 -05:00
jrusso1020 fa683cab7d address comments 
Signed-off-by: jrusso1020 <jrusso@brex.com>
 2021-11-27 12:36:29 -05:00
Ben Lambert 35b606102b Merge pull request #8130 from backstage/blam/docsupdate 
docs: Link out to Custom Field Extensions
 2021-11-18 10:57:29 +01:00
Ben Lambert 770b5eda87 Merge pull request #7908 from anthonyikeda/master 
Placed the Custom Actions pre-requisites at the top of the document i…
 2021-11-18 10:27:31 +01:00
blam d73ae57163 docs: updating the docs saying that it is now possible to provide your own Field Extensions 
Signed-off-by: blam <ben@blam.sh>
 2021-11-18 10:24:04 +01:00
Ben Lambert a4faa290b8 Merge pull request #7780 from backstage/joonp/provide-scaffolder-template-metadata 
Expose template metadata to custom action handler
 2021-11-17 20:59:11 +01:00
blam a648d763d7 chore: fixing pr comments 
Signed-off-by: blam <ben@blam.sh>
 2021-11-17 20:17:08 +01:00
Joon Park ecdcbd08ee Expose template metadata to custom action handler 
Currently, we only expose the template name to satisfy the requirement from the issue, but more can be added easily (as long as the type is expanded accordingly).

Signed-off-by: Joon Park <joonp@spotify.com>
 2021-11-14 20:24:20 +00:00
Anthony Ikeda 69f06b7db5 Ran Prettier and reformatted the file 
Signed-off-by: Anthony Ikeda <anthony.ikeda@gmail.com>
 2021-11-11 08:45:44 -08:00
Anthony Ikeda ac4eeb7102 More consistent formatting of the Note block 
Signed-off-by: Anthony Ikeda <anthony.ikeda@gmail.com>
 2021-11-10 21:06:06 -08:00
Anthony Ikeda 02ebae6ffd Removed code block at top and altered the main registration code block to include the builtInActions registration 
Signed-off-by: Anthony Ikeda <anthony.ikeda@gmail.com>
 2021-11-10 20:55:28 -08:00
Anthony Ikeda 677da179d8 More consistent formatting of the Note block 
Signed-off-by: Anthony Ikeda <anthony.ikeda@gmail.com>
 2021-11-10 20:55:28 -08:00
Anthony Ikeda 5b9d1291f7 Placed the Custom Actions pre-requisites at the top of the document instead of the middle. These **pre-requisites** are easily missed if developers are writing custom actions. 
Signed-off-by: Anthony Ikeda <anthony.ikeda@gmail.com>
 2021-11-09 08:48:04 -08:00
Jason Nguyen d393a3bd2a [docs] clarify example showing that parameters types propagate 
Signed-off-by: Jason Nguyen <jason-nguyen@pluralsight.com>
 2021-11-08 14:22:22 -07:00
Thomas Viaud 224e545a75 fix: run prettier 
Signed-off-by: Thomas Viaud <t.viaud@elsevier.com>
 2021-10-27 18:34:57 +01:00
Thomas Viaud 08de4fa957 fix: Adding corrected code documentation for custom field extension 
Signed-off-by: Thomas Viaud <t.viaud@elsevier.com>
 2021-10-27 18:34:45 +01:00
Johan Haals baa03d72e9 Merge pull request #7788 from RoadieHQ/custom-actions 
List custom scaffolder action packages
 2021-10-27 09:41:33 +02:00
Nicolas Arnold 1a705377ff List custom scaffolder action packages 
This here adds a table with a list of opensource scaffolder actions that can be used by anyone in the community.

Signed-off-by: Nicolas Arnold <nic@roadie.io>
 2021-10-26 17:30:34 +01:00
blam 7fe6c0bb70 chore: reworking the docs a little bit 
Signed-off-by: blam <ben@blam.sh>
 2021-10-14 12:07:20 +02:00
blam 8893feca73 chore: docs updates 
Signed-off-by: blam <ben@blam.sh>
 2021-10-14 12:07:20 +02:00
blam 808d30cc30 docs: removing older documentation for now 
Signed-off-by: blam <ben@blam.sh>
 2021-10-14 12:07:20 +02:00
Adam Harvey bf6c664357 Reword sentence based on feedback 
Signed-off-by: Adam Harvey <adaharve@cisco.com>
 2021-10-07 12:45:31 -04:00
Adam Harvey f90b0a421a Fix bullet 
Signed-off-by: Adam Harvey <adaharve@cisco.com>
 2021-10-07 12:42:13 -04:00
Adam Harvey 9ac7f7c891 Fix typo & update here links 
Signed-off-by: Adam Harvey <adaharve@cisco.com>
 2021-10-07 09:44:48 -04:00
Adam Harvey 7d2899c06b Minor editoral tweaks (punctuation, etc.) 
Signed-off-by: Adam Harvey <adaharve@cisco.com>
 2021-10-07 09:41:32 -04:00
Ben Lambert 7f4aa44192 Merge pull request #7172 from backstage/blam/creating-custom-scaffolder-field-extensions 
docs: Added Documentation for `customFieldExtensions`
 2021-09-15 11:23:01 +02:00
blam cf4f80d50b chore: updating review emcomments 
Signed-off-by: blam <ben@blam.sh>
 2021-09-15 10:52:29 +02:00
Adam Harvey 6472a6fd4f Wrapping not needed with prettier-ignore for YAML frontmatter 
Signed-off-by: Adam Harvey <adaharve@cisco.com>
 2021-09-14 19:05:50 -04:00
blam 114a10fe9c chore: added some more docs around field extensions 
Signed-off-by: blam <ben@blam.sh>

Signed-off-by: blam <ben@blam.sh>
 2021-09-14 12:12:32 +02:00
blam 67ee34dcae docs: added some more examples 
Signed-off-by: blam <ben@blam.sh>
 2021-09-14 12:12:32 +02:00
blam df1504c9ca chore: added some more lines of documentation 
Signed-off-by: blam <ben@blam.sh>
 2021-09-14 12:12:32 +02:00