paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 28 Packages Projects Releases Wiki Activity
17,219 Commits 1 Branch 0 Tags
6f82fef1979514bab34b68df02ab62ae788a35ba
Commit Graph

170 Commits

Author SHA1 Message Date
Fredrik Adelöw 12e074a6e4 get rid of some core-api mentions too 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
 2021-09-23 15:16:41 +02:00
Víctor bcc35de246 Run pretier on app-custom-theme.md 
Signed-off-by: Víctor <vsuarez@idealista.com>
 2021-09-15 22:21:05 +02:00
Víctor Suárez Fernández e9850f784e Add missing commas to app-custom-theme docs 
Signed-off-by: Víctor Suárez Fernández <vicsufer@gmail.com>
Signed-off-by: Víctor <vsuarez@idealista.com>
 2021-09-15 17:13:15 +02:00
Patrik Oldsberg d4e614bb1d remove docgen package 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
 2021-09-12 23:16:11 +02:00
Brent Schneider 2fab1dd10d Update app-custom-theme.md 
added missing coma in the pageTheme header color list.

Signed-off-by: Brent Schneider <Brent.schneider@adhocteam.us>
 2021-09-01 15:28:18 -07:00
blam b05210593d chore: bump the version of material-ui core to 4.12.2 
Signed-off-by: blam <ben@blam.sh>
 2021-07-27 23:44:43 +02:00
Tim Hansen 88f2a786df Remove Python requirement from docs 
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
 2021-07-21 15:26:06 -06:00
Patrik Oldsberg 642cec7ac7 docs: remove references to @backstage/core 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
 2021-06-24 12:50:40 +02:00
Patrik Oldsberg c7126e7a86 docs,workflows: remove or update references to packages/core(-api) 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
 2021-06-24 12:50:40 +02:00
Patrik Oldsberg e167019158 docs: move project structure to getting started 
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
 2021-06-18 11:37:45 +02:00
Himanshu Mishra 0cf2ddbbff docs: Link sqlite to postgres switch tutorial in create app page 
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
 2021-06-04 11:37:41 +02:00
Adam Harvey 0568748677 Add custom logo instructions 
Signed-off-by: Adam Harvey <adaharve@cisco.com>
 2021-05-01 08:26:22 -04:00
Patrik Oldsberg c614ede9a5 docs: update plugin installation docs 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
 2021-04-22 18:32:54 +02:00
Adam Harvey 2373468553 Merge pull request #5332 from adamdmharvey/update-plugin-doco 
docs: Update plugin example for composability
 2021-04-15 14:47:21 -04:00
Adam Harvey 2c1fc4969c Clarify example 
Signed-off-by: Adam Harvey <adaharve@cisco.com>
 2021-04-15 14:41:10 -04:00
Adam Harvey 1c1dc8ac28 Fix pluginname 
Signed-off-by: Adam Harvey <adaharve@cisco.com>
 2021-04-15 12:42:03 -04:00
Tim 387efd9f02 Merge pull request #5337 from backstage/timbonicus/deployment-docs 
Move deployment documentation to its own section
 2021-04-15 10:25:28 -06:00
Fredrik Adelöw c28689c686 change all $env to ${} 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
 2021-04-15 13:26:44 +02:00
Tim Hansen 7114108898 Move deployment documentation to its own section 
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
 2021-04-14 20:48:42 -06:00
Adam Harvey 387c28b9d3 Update plugin example for composability 
Signed-off-by: Adam Harvey <adaharve@cisco.com>
 2021-04-14 14:42:50 -04:00
Ben Lambert 3f3637dcd9 Merge pull request #5284 from trumant/plugin-docs-sidebar-correction 
Correcting the path to the Root component in the plugin docs
 2021-04-12 10:05:35 +02:00
Ben Lambert e4827ef779 Merge pull request #5237 from rkristelijn/master 
fix: adds pagetheme colors
 2021-04-12 10:00:33 +02:00
Travis Truman 8210a2ea52 Correcting the path to the Root component 
Signed-off-by: Travis Truman <trumant@gmail.com>
 2021-04-10 15:48:08 -04:00
Remi Kristelijn 36e233cb02 fix: missing code 
Signed-off-by: Remi Kristelijn <remi.kristelijn@theapsgroup.com>
 2021-04-09 09:11:50 +02:00
Remi Kristelijn 24aed6be94 fix: feedback 
Signed-off-by: Remi Kristelijn <remi.kristelijn@theapsgroup.com>
 2021-04-08 06:25:57 +02:00
Remi Kristelijn 4438b0f6e8 fix adds pagetheme colors 
closes #5235

Signed-off-by: Remi Kristelijn <remi.kristelijn@theapsgroup.com>
 2021-04-07 08:43:29 +02:00
blam cba45d6f6c chore: fixing the docs based on @eXpire163 PR 
Signed-off-by: blam <ben@blam.sh>
 2021-03-31 15:23:29 +02:00
cirpo 075aec605d fixed backstage clone url instruction in the contributors page 
Signed-off-by: cirpo <alessandro.cinelli@gmail.com>
 2021-03-29 11:21:03 +01:00
Oliver Sand 72192d847b Improve documentation 
`defaultPageTheme` is a required field.

Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
 2021-03-25 15:56:49 +01:00
Tim 4e1227ce2e Merge pull request #5032 from backstage/timbonicus/create-app-updates 
Update create-app template for better parity with example app
 2021-03-25 06:23:36 -06:00
Patrik Oldsberg ce560648b3 Merge pull request #5052 from maikelvl/patch-1 
Fix docs on Helm install commands.
 2021-03-24 22:02:31 +01:00
Adam Harvey 7cb67326c4 Apply feedback 
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
 2021-03-24 14:52:49 -04:00
Adam Harvey 3846a67f04 Fix typo 
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
 2021-03-24 14:35:48 -04:00
Adam Harvey 1f2bdb81c4 Add Key Concepts page 
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
 2021-03-24 14:31:15 -04:00
Adam Harvey aa9bcba113 Clarify contributing 
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
 2021-03-24 14:31:00 -04:00
Maikel 628e7382ec Fix docs on Helm install commands. 
Signed-off-by: Maikel Vlasman <github-82jnd5llq8fji7v5@maikelvlasman.com>
 2021-03-22 14:16:30 +01:00
Tim Hansen f88fe9dd9b Update create-app template for better parity with example app 
Fixes #4613

Signed-off-by: Tim Hansen <timbonicus@gmail.com>
 2021-03-19 15:18:26 -06:00
Patrik Oldsberg 4c80c7203a docs: differentiating detailed docker deployment documentation descriptions 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
 2021-03-18 19:51:49 +01:00
Ben Lambert b028502c2d Merge pull request #4826 from backstage/timbonicus/keep-updated 
Move the keeping-updated topic to getting-started
 2021-03-09 16:50:43 +01:00
Adam Harvey b636f3031b Update getting started for yarn dev 
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
 2021-03-08 14:46:00 -05:00
Tim Hansen bae135c88e Merge branch 'master' into timbonicus/keep-updated 2021-03-08 08:06:16 -07:00
Tim Hansen 2369c72cac Update words, add versions:check section 
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
 2021-03-05 09:31:36 -07:00
Tim Hansen c694e47360 Move the keeping-updated topic to getting-started 
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
 2021-03-04 19:45:12 -07:00
Tim Hansen b17819246c Add note about monorepo 
Signed-off-by: Tim Hansen <timbonicush@spotify.com>
 2021-03-04 11:58:20 -07:00
Tim Hansen ffdae9be17 Update documentation, remove CircleCI from default app 
Signed-off-by: Tim Hansen <timbonicush@spotify.com>
 2021-03-03 15:38:50 -07:00
Tim Hansen 64615dd726 Fix relative link 2021-03-01 14:52:55 -07:00
Tim Hansen cdd6d1db7c docs: Improve flow for getting-started docs 2021-03-01 14:33:29 -07:00
Patrik Oldsberg 4097031e6a Update docs/getting-started/contributors.md 
Co-authored-by: Adam Harvey <adam.harvey@dxc.com>
 2021-02-25 22:27:04 +01:00
Patrik Oldsberg 3bc7365bbc docs: added note about marking frontend config visible 2021-02-25 18:40:40 +01:00
Olle Lundberg 79f7461709 Recommend a safer find command 
Piping find to xargs is dangerous as xargs will interpret any characters
defined in $IFS (Input Field Separator), usually <space><tab><newline>,
as separators in its input. This might lead to unintented operations
on files if any of the input to xargs containts any of the characters
defined in $IFS, most often this happens if a file contains a space in
its name. The safest way to execute a find | xargs is to force find to
separate its output with null characters and tell xargs to read null
characters as the delimiter AND also tell xargs to put the argument to
the command its supposed to run in quotation marks:
   `find ... -print0 | xargs -I {} -0 rm -rf "{}"`
When running with GNU find you most likely also want to add
--no-run-if-empty or -r for short:
   `find ... -print0 | xargs -I {} -0 --no-run-if-empty rm -rf "{}"`
This stops the invocation of xargs if there is no input on stdin, this
is however not portable and will break on BSD/macOS, the portability is
not a concern in this case though as the find | xargs happens in docker.

As you can see this gets unwieldly fast and despite using every
precaution, it's still not safe. When xargs is run with -0 to treat null
characters as the delimiter for its input and a file has a null
character in its name, xargs will treat the null character in the file
name as a delimiter and xargs will exhibit the same behaviour as it did
with spaces in file names.

Ahhh, isn't Unix wonderful? Loose APIs defined as untyped strings...

There is a salvation though! Most find xargs pipes are unnecessary and
can be replaced with built in functionality in find, the -exec flag.
Now, -exec comes in 2 flavours, one that is terminated with \; (the most
commonly used) and one terminated with \+ (the one most people actually
want to use). \; spawns a new invocation per found entry, thus creating
some process creation overhead. \+ instead concatenates the found
entries as arguments to the program we want to run, resulting in less
overhead and usually a faster execution.
Since find is smart enough to be aware of what constitutes an entry
(i.e it doesn't treat the entries as just a bunch of random strings to
read from stdin) it makes the whole invocation of the program, rm in
this case, safe even if it contains characters defines in $IFS or null
characters.

And with this overly elaborate commit message I bring you this 1 line
change.
 2021-02-19 09:57:32 +01:00