Commit Graph

48 Commits

Author SHA1 Message Date
Patrik Oldsberg f4fcce8cdc backend -> backend-legacy, backend-next -> backend
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2024-05-06 15:21:02 +02:00
web-next-automation f93376c5dd fix: update config reading for NBS
Signed-off-by: web-next-automation <web-platform@doordash.com>
2024-04-07 19:36:19 -04:00
solimant 5496dd994b Update docs/conf/writing.md
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
Signed-off-by: solimant <solimant@users.noreply.github.com>
2024-03-12 16:01:51 +00:00
solimant 99bab65ff7 Support env var parameter substitution
Signed-off-by: solimant <solimant@users.noreply.github.com>
2024-03-12 14:41:02 +00:00
Patrik Oldsberg b017906f7a docs/config/writing: document new null behavior
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2024-02-29 21:34:06 +01:00
Fredrik Adelöw 613e2bfe03 extend the visibility docs with deep visibility
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2024-02-22 11:59:53 +01:00
Alex 4841d6db89 Update writing.md
apply suggestions

Signed-off-by: Alex <52247724+Elya29@users.noreply.github.com>
2024-02-02 14:19:22 +01:00
Alex 93bb6b425f Update writing.md
Edit message to be more explicit about the secret RSA private keys

Signed-off-by: Alex <52247724+Elya29@users.noreply.github.com>
2024-01-29 10:30:57 +01:00
Alex 90c5f9db54 Update writing.md
add warning about hard coded RSA Private Keys.

Signed-off-by: Alex <52247724+Elya29@users.noreply.github.com>
2024-01-25 10:32:34 +01:00
Fredrik Adelöw a12f58054d tweak the config docs slightly
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2023-04-26 10:28:13 +02:00
Fredrik Adelöw cbe11d1e23 just getting rid of vale warnings
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-10-22 17:18:47 +02:00
Alex Crome 0e14a26749 Updated Configuration definition docs
Added sample for what `package.json` should look like when defining a `configSchema`

Signed-off-by: Alex Crome <afscrome@users.noreply.github.com>
2022-10-10 12:31:23 +01:00
Patrik Oldsberg 89bb53685c vale: prune accepted vocabulary
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-04-27 18:44:55 +02:00
Praveen Ranjan Keshri 1e7070443d Fixes post review by Rugvip:
1. Ensuring that reloadIntervals, if present, is a valid positive number
2. Remote config error message fix
3. Removed remote config from example backend
4. Lessened the writing.md
5. Multiple changesets

Signed-off-by: Praveen Ranjan Keshri <prkeshri@gmail.com>
2021-12-08 00:21:53 +05:30
Praveen Ranjan Keshri 776180b740 Fixed bug in backend-common to allow passing of remote option in order to enable passing remote url in --config option. The remote option should be passed along with reloadIntervalSeconds from packages/backend/src/index.ts (Updated the file as well)
Signed-off-by: Praveen Ranjan Keshri <prkeshri@gmail.com>
2021-11-25 01:59:54 +05:30
Otto Sichert b23bc7f9c3 Change default port of backend to 7007 due to MacOS Control Center update
Signed-off-by: Otto Sichert <git@ottosichert.de>
2021-11-18 16:45:57 +01:00
Matto ce843364f0 Remove the dependency on Etag headers for reloading config
Signed-off-by: Matto <muhamadto@gmail.com>
2021-10-29 12:47:18 +11:00
Matto e51740f9c9 Added documentation
Signed-off-by: Matto <muhamadto@gmail.com>
2021-10-29 12:44:07 +11:00
Patrik Oldsberg 40199b61d6 cli: include root package in schema search + update docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-25 17:46:07 +02:00
Patrik Oldsberg e65c42aa77 docs: fix reference links
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-12 15:41:29 +02:00
Patrik Oldsberg 8d30e0ec04 docs: remove references to removed utility API docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-12 14:43:47 +02:00
Júlio Zynger 6548b9e23f Add code sample for ConfigApi access in frontend
Per https://discord.com/channels/687207715902193673/687235481154617364/885085310101377034

Signed-off-by: Julio Zynger <julio.zynger@soundcloud.com>
2021-09-08 14:45:25 +02: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
Crevil 23ad991a17 Add example of visibility of config values
Emphasize how to set config visibility in the docs with an example.

Signed-off-by: Crevil <bjoern.soerensen@gmail.com>
2021-06-17 09:20:45 +02:00
Patrik Oldsberg 6320b24bbb docs: add paragraph on how to view local config docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-01 19:51:17 +02:00
blam 53c7a9dbeb docs: mention that the configuration is shared between the backend and the frontend
Signed-off-by: blam <ben@blam.sh>
2021-06-01 17:16:19 +02: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
JP Dhabolt 97beeecb61 Update docs and changeset
Signed-off-by: JP Dhabolt john.p.dhabolt@gmail.com
Signed-off-by: JP Dhabolt <jdhabolt@agero.com>
2021-03-31 15:34:14 +00:00
Patrik Oldsberg 3740a8bcb4 docs/conf: add env var substitution docs 2021-01-25 00:17:30 +01:00
Patrik Oldsberg 78a81c1be4 docs/conf: update config writing docs to talk about includes instead of secrets 2021-01-25 00:17:30 +01:00
Johan Haals b1f835a27f Merge pull request #3903 from backstage/mob/data-secret
Config: Add $include which replaces $data and can include any value
2021-01-05 09:56:45 +01:00
Patrik Oldsberg be236536e7 docs: show how to assign annotations to primitive array item types in config schema 2021-01-04 19:39:36 +01:00
Johan Haals 24b81b3acd Add documentation for config $include 2021-01-04 15:57:09 +01:00
Himanshu Mishra 675b5d2769 docs: Add a table for visibility values in our JSON Schema 2020-12-11 10:48:53 +01:00
Patrik Oldsberg 80bf8c7f4f cli: rename config:validate to config:check 2020-11-18 11:31:20 +01:00
Patrik Oldsberg 0b97a89f55 address config schema review comments 2020-11-18 11:31:19 +01:00
Patrik Oldsberg 82043bfe8b docs: add docs for configuration schema 2020-11-18 11:31:17 +01:00
Adam Harvey a51d475899 Standarize code fence and wording tweaks (#3285) 2020-11-13 08:51:11 +01: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
Patrik Oldsberg c2ea3cd26a docs: updated to reflect new --config flags 2020-10-22 10:52:07 +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
Patrik Oldsberg 6775deef9b update docs and examples to use shorter config secret syntax 2020-10-04 16:51:00 +02:00
Rajiv Ranjan Singh def4032351 added description header field 2020-09-16 21:47:19 +05:30
Ivan Shmidt 045d796667 Merge branch 'master' of github.com:spotify/backstage into mob/docusaurus-structure 2020-08-13 10:15:01 +02:00
Paul Pacheco 88d4e1adf7 This is supposed to be optional 2020-08-12 17:10:51 -05:00
Ivan Shmidt 0867d3dc30 feat: more docs to backstage.io 2020-08-12 12:06:14 +02:00
Patrik Oldsberg b25ffdc958 docs: added configuration docs (#1863)
* docs: added configuration docs

* docs: add all config pages to ToCs
2020-08-09 22:34:04 +02:00