Commit Graph

3802 Commits

Author SHA1 Message Date
Alex Crome 76bad23a8c Microsoft authentication doc clafications
* Add API Permissions to the app registration setup
* Encouraged re-use of an existing app registration over creating a new one.
* Moved the `Adding the provider to the Backstage front end` higher up so it's not so easily missed

Updated the microsoft authentication document to include details on adding API Permissions.
At more relaxed companies, these permissiosn will be silently added to this list the first time they're requested, however in more locked down companies, a directory admin will need to consent to these permissions before users can use them.

Also slighlty reworked the docs to encourate re-using any existing app registration.  This includes renaming the `AUTH_MICROSOFT_*` variables to match the `AZURE_*` ones used throughout other azure integrations.

Signed-off-by: Alex Crome <afscrome@users.noreply.github.com>
2023-10-18 23:14:26 +01:00
John Kriter c814a3fbdd Update locations.md
The purpose of this change is to highlight the style of API access token required to enable the Bitbucket Cloud integration as it was not previously clear. The existing error will not distinguish between an Atlassian Account key(which wont work) and a Bitbucket App Password(which will.

Signed-off-by: John Kriter <john.r.kriter@accenture.com>
2023-10-18 14:24:21 -06:00
Patrik Oldsberg 62735024ad docs/features/techdocs: wrap file extensions in code blocks
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-17 13:10:14 +02:00
Camila Belo 9796eaea8b docs: update microsite configs
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2023-10-17 11:43:11 +02:00
Camila Belo 9b1e71a7e7 docs: draft a v1.19.0 release notes
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2023-10-17 11:43:11 +02:00
github-actions[bot] 8cdb8c2e40 Version Packages 2023-10-17 08:54:50 +00:00
Patrik Oldsberg b732b92b36 docs/publishing: remove link to pre.json
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-17 10:40:22 +02:00
rtriesscheijn 4bbde87a2e fix: pass full config to StaticTokenIssuer, documentation and test tweaks
Signed-off-by: rtriesscheijn <rtriesscheijn@bol.com>
2023-10-17 09:08:42 +02:00
Patrik Oldsberg 601f2570ab docs/release-notes-template: add in
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-16 11:00:08 +02:00
rtriesscheijn bdf08ad04a feat: add static token issuer
Signed-off-by: rtriesscheijn <rtriesscheijn@bol.com>
2023-10-16 10:48:48 +02:00
Patrik Oldsberg ae8812c151 changesets: tweak changeset for backend start change
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-12 11:13:46 +02:00
John Philip 310f6ea5e1 Merge pull request #20229 from Ericsson/plantuml-support-enhancement
[TechDocs] Enhance PlantUML support in the techdocs container to include external puml or pu files
2023-10-11 15:08:14 -04:00
Fredrik Adelöw 4cfe1fb455 Merge pull request #20450 from Teemukoivumaa/fix/arrayOfObjects
fix: init array with another types with one item
2023-10-11 12:18:37 +02:00
Fredrik Adelöw 33de43f491 Merge pull request #20498 from Silthus/docs/local-config
docs: add example for including local catalog files
2023-10-11 11:50:13 +02:00
Fredrik Adelöw 815d798633 Merge pull request #19849 from raffitamizian/add-use-redis-sets
Exposes the useRedisSets config option for keyv redis
2023-10-11 11:28:04 +02:00
github-actions[bot] e43d3eb1b7 Version Packages (next) 2023-10-10 11:39:03 +00:00
Reichenbach, Michael e57ba03798 docs: add example for including local catalog files
Signed-off-by: Reichenbach, Michael <michael.reichenbach@interhyp.de>
2023-10-10 13:34:06 +02:00
Patrik Oldsberg d5758bbfa8 Merge pull request #19971 from awanlin/docs/updated-around-other-pulgin-types
docs: updated around other plugin types
2023-10-10 11:56:42 +02:00
Teemu Koivumaa f932ee9865 docs: make arrayObjects more usable from the start
Signed-off-by: Teemu Koivumaa <teemuk15@gmail.com>
2023-10-09 20:02:18 +03:00
Patrik Oldsberg 2724c331ed Merge pull request #20457 from backstage/rugvip/nosvgicon
cli: deprecate support for .icon.svg
2023-10-09 10:14:46 +02:00
Patrik Oldsberg 2ef6522552 cli: deprecate support for .icon.svg extensions
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-08 12:19:34 +02:00
Morgan Bentell 60f9546a0d update cli documentation
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-10-06 11:14:45 +02:00
Hannes Jetter c437253b7a Refactored TechDocsCollator; added
entityTransformer functionality

Signed-off-by: Hannes Jetter <hannes.jetter@aeb.com>
2023-10-06 02:24:39 +02:00
John Philip 94c762414b Merge pull request #20109 from kurtaking/remove-alpha-from-import
docs: remove alpha from import in techdoc addons
2023-10-05 19:00:22 -04:00
Fredrik Adelöw 5addd014a6 just some small fixes to the testing docs
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2023-10-05 09:32:20 +02:00
Camila Belo 8623fdeca8 refactor(search): apply review suggestions - second round
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2023-10-04 15:05:29 +02:00
Camila Belo 861fd40fe8 refactor(search): apply review suggestions
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2023-10-04 15:04:49 +02:00
Camila Belo 165c5edf04 docs(search): draft search extension docs page
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2023-10-04 15:04:49 +02:00
github-actions[bot] f95345c845 Version Packages (next) 2023-10-03 10:49:45 +00:00
Patrik Oldsberg 273d182509 Merge pull request #20277 from jerolimov/patch-1
Update proxying.md
2023-10-03 12:41:39 +02:00
Fredrik Adelöw cea09c6a94 Merge pull request #20140 from backstage/vinzscam/docs-github-org-data-improvements
docs: fix userTransformer references in github integration
2023-10-03 10:48:40 +02:00
Fredrik Adelöw e875f3f257 Merge pull request #20242 from awanlin/topic/clarify-docker-node-and-debian-version
Clarified docker node and Debian version
2023-10-03 09:13:12 +02:00
Vincenzo Scamporlino 7ec10602ff catalog-backend-module-github: fix defaultUserTransformer typings
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2023-10-02 16:58:17 +02:00
Patrik Oldsberg ec01b3dad7 Merge pull request #20012 from backstage/mob/mainline-release-docs
Update publishing.md
2023-09-29 18:26:17 +02:00
Patrik Oldsberg 19e9b4d4ef docs/publishing: update to use relative URLs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-09-29 18:09:04 +02:00
Fredrik Adelöw 0ac32b4670 Merge pull request #20166 from Symbianx/patch-1
Updates the techdocs instructions to not fail when using zsh
2023-09-29 17:16:33 +02:00
Christoph Jerolimov f302e15080 Update proxying.md
Add endpoints to the proxy examples, as used in the sample app-config.yaml

Signed-off-by: Christoph Jerolimov <jerolimov+github@redhat.com>
2023-09-29 16:52:54 +02:00
Patrik Oldsberg 085cfdb180 docs/publishing: update release notes template link
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-09-29 13:51:46 +02:00
Philipp Hugenroth 812c1f4c16 Update publishing.md
Signed-off-by: Philipp Hugenroth <tudi2d@users.noreply.github.com>
2023-09-29 13:50:44 +02:00
Philipp Hugenroth 934fdc0ecf Update docs/publishing.md
Co-authored-by: Camila Belo <camilaibs@gmail.com>
Signed-off-by: Philipp Hugenroth <tudi2d@users.noreply.github.com>
2023-09-29 13:50:44 +02:00
Philipp Hugenroth 96a01bd464 Update publishing.md
Signed-off-by: Philipp Hugenroth <tudi2d@users.noreply.github.com>
2023-09-29 13:50:44 +02:00
Lavanya Sainik acf7400c5a [TechDocs] Enhance PlantUML support in the techdocs container to include external puml or pu files
Issue Reference  #20184

Signed-off-by: Lavanya Sainik <lavanya.sainik@ericsson.com>
2023-09-29 10:42:45 +01:00
Patrik Oldsberg 9ae8949df7 Merge pull request #20225 from backstage/rugvip/notes-template
docs: add release notes template
2023-09-29 10:47:13 +02:00
Patrik Oldsberg 63bf2d7279 docs: add release notes template
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-09-29 10:30:18 +02:00
Andre Wanlin 9edd866945 Clarified docker node and debian version
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-09-28 14:25:48 -05:00
Andre Wanlin 149af9bfca changes based on feedback
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-09-28 14:15:33 -05:00
Andre Wanlin 9aa26f8c61 Corrected image
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-09-28 14:11:43 -05:00
Andre Wanlin 17bf9fce0b docs: updated aroung other plugin types
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-09-28 14:11:43 -05:00
Jasper Boeijenga b39116962e Merge branch 'backstage:master' into master 2023-09-28 13:44:51 +02:00
Jasper Boeijenga a6e09d8712 Fixed documentation mistake on configuring routes
Signed-off-by: Jasper Boeijenga <jboeijenga@gmail.com>
2023-09-28 13:43:41 +02:00