Commit Graph

123 Commits

Author SHA1 Message Date
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
Patrik Oldsberg 021c70d673 Merge pull request #4564 from backstage/rugvip/docker-builds
docker: switch to backend:bundle + update docs with both host and multi-stage build
2021-02-18 11:01:47 +01:00
Patrik Oldsberg 38fe527d97 dockerfile: mention build-image command 2021-02-17 21:23:12 +01:00
Patrik Oldsberg 40f0c33378 update backend Dockerfile to use config example and fix comment 2021-02-17 20:44:40 +01:00
Patrik Oldsberg d13aea9cd2 docs: add full docker deployment docs 2021-02-17 20:44:10 +01:00
blam d7abf2a2db chore: fix some other wording 2021-02-16 15:19:31 +01:00
blam 687ddc49d7 chore: reworking the title of the docs to avoid confusion 2021-02-12 23:50:03 +01:00
blam cbf4566ed6 docs: rework the getting started documentation for both contributors and integraters are seperated 2021-02-12 23:31:55 +01:00
Alex C. Bilimoria 0009804a84 Update docker run command in deployment-other.md 2021-02-04 09:58:41 -07:00
Adam Harvey e763dcf8c4 Fix Backstage case 2021-01-29 14:17:09 -05:00
blam 1f675381a9 chore: fixing vale stuff 2021-01-27 21:59:44 +01:00
blam e9b9fa2ffe chore: added a note about .dockerignore 2021-01-27 16:38:27 +01:00
blam 8080d1ef4f chore: change the wording slightly 2021-01-26 17:39:28 +01:00
blam 2dee00292c chore: review comments 2021-01-26 17:34:52 +01:00
blam 6cc06d4e7f chore: fixing spelling of docs 2021-01-26 15:56:33 +01:00
blam ad52b78b8d chore: reworking the files so that it's moved to docs instea 2021-01-26 15:55:34 +01:00
Patrik Oldsberg f5cc804ca3 docs: add docs for how to handle type checking issues with linked in packages 2021-01-16 15:44:40 +01:00
Fredrik Adelöw ffa36ff101 Merge pull request #3927 from adamdmharvey/doco-prettier-seo
docs: Align Docusaurus for fixed SEO output and "prettier" happiness
2021-01-12 21:42:53 +01:00
Himanshu Mishra 7712795f9b docs: add port to url 2021-01-12 17:46:24 +01:00
Adam Harvey 14466940f7 Single line metadata and prettier ignore 2021-01-05 13:42:31 -05:00
Frieder Bluemle cbd3a44c09 Fix typos (#3646) 2020-12-09 07:50:41 +01:00
Stefan Ålund 0ebfc75b41 Fix docs 2020-11-26 20:50:32 +01:00
Stefan Ålund 63998e65b1 Update docs/getting-started/configure-app-with-plugins.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2020-11-26 20:27:10 +01:00
Stefan Ålund 276a9e5919 Update docs/getting-started/configure-app-with-plugins.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2020-11-26 20:27:02 +01:00
Stefan Ålund 05b54d8b17 Update docs/getting-started/configure-app-with-plugins.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2020-11-26 20:26:53 +01:00
Stefan Ålund a00c393b38 Add API docs plugin to new apps 2020-11-26 14:20:47 +01:00
Kevin Kelly ed08863e17 docs: create an app, node version update 2020-11-21 23:48:36 -05:00
Kevin Kelly 031ead5f5a docs: update local install example for node v14 2020-11-21 23:33:32 -05:00
Patrik Oldsberg 206dce0bf8 docs/create-app: document external package linking 2020-11-20 11:42:08 +01:00
David Tuite eecf08e3f7 Update Node LTS in Getting Started docs (#3254)
I've tested and the v14 [Fermium LTS](https://nodejs.org/en/about/releases/) works fine.
2020-11-06 00:32:13 +01:00
Adam Harvey 1fddc73322 Additional folder rename fix 2020-11-03 22:03:53 -05:00
Patrik Oldsberg 474bb5b57f rewrite other references to spotify/backstage and sorrounding things 2020-11-03 11:39:27 +01:00
Patrik Oldsberg af141c0766 rewrite repo location urls 2020-11-03 11:03:49 +01:00
Harvey 2e04225056 Prettier fix for line length 2020-10-26 09:49:54 -04:00
Harvey 2e48d035ff Capitlize product name 2020-10-25 23:27:03 -04:00
Harvey 8e2f88e965 Capitalize Docker 2020-10-25 23:26:15 -04:00
Harvey 024173b0ce Reword and code type 2020-10-25 23:25:52 -04:00
Harvey 608236d0bb Align 2020-10-25 23:25:02 -04:00
Adam Harvey a06164da24 Documentation editorial review (#3055)
* Fix case and link

* Align product/vendor case

* Reword for readability

* YAML Case

* Align product names

* Align product and acronym case

* Remove here link and product naming

* Align Node.js naming

* Align product names

* Fix wording
2020-10-23 08:01:07 +02:00
Patrik Oldsberg 3dda28f908 Merge pull request #2954 from mplesec/issue/2935/update-docs-re-npm-config-flag
docs: update docs regarding npm config ignore-scripts flag
2020-10-18 19:24:15 +02:00
Matic Plešec edeb5e45a3 Update docs regarding npm config ignore-scripts flag 2020-10-18 18:36:05 +02:00
Stefan Ålund 4df45e0083 (docs) Add Helm charts, cleanup (#2944)
* (docs) Add Helm charts, cleanup

* (docs) Add Helm charts, cleanup
2020-10-17 20:54:47 +02:00
Patrik Oldsberg 2d15cfb1a4 docs/getting-started: added some minimal docs for k8s deployment, referencing contrib example 2020-10-17 15:23:17 +02:00
Marcus Eide 6afe4da5f4 Merge pull request #2663 from RoadieHQ/add-helm-charts
feat: add basic Helm charts for deploying backstage
2020-10-12 15:21:07 +02:00
Martina Iglesias Fernandez cafe45b4a9 Fix feedback from dtuite 2020-10-12 09:24:30 +02:00
Martina Iglesias Fernandez dd5be710f5 Move the k8s deployment docs to its own helm deployment page 2020-10-12 09:24:30 +02:00
Martina Iglesias Fernandez 6289cea398 Add more documentation to charts README and k8s guide 2020-10-12 09:24:29 +02:00
Patrik Oldsberg 8afce088ac Use APP_ENV to determine what config to load, falling back to NODE_ENV 2020-10-10 17:41:03 +02:00