Vincenzo Scamporlino
31783a711c
Merge pull request #21953 from backstage/vinzscam/catalog-docs
...
docs: add by-query endpoint
2023-12-22 21:56:29 +01:00
Fredrik Adelöw
2e6c56bb8e
update release status wording for the new backend system
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2023-12-22 13:58:00 +01:00
Vincenzo Scamporlino
4522a4ba24
Apply suggestions from code review
...
Co-authored-by: Fredrik Adelöw <freben@gmail.com >
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com >
2023-12-22 10:45:32 +01:00
Vincenzo Scamporlino
38c2ecccd1
docs: add by-query endpoint
...
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com >
2023-12-20 12:46:19 +01:00
blam
b7902a715d
chore: fixing docs
...
Signed-off-by: blam <ben@blam.sh >
2023-12-18 17:27:50 +01:00
blam
82af648de3
chore: reset some testing files and fix docs
...
Signed-off-by: blam <ben@blam.sh >
2023-12-18 14:34:02 +01:00
blam
30f2066896
chore: added documentation and deprecating old method
...
Signed-off-by: blam <ben@blam.sh >
2023-12-18 14:18:07 +01:00
Keran Yang
f7eeb10854
Update life-of-an-entity.md
...
Signed-off-by: Keran Yang <yangkr920208@gmail.com >
2023-12-13 11:03:41 -05:00
Christof Leuenberger
3452e3dd02
Describe how to add standalone techdocs
...
The documentation template doesn't seem to exist any longer.
Add the minimal steps in order to help users get started with
creating a standalone techdocs documentation.
Signed-off-by: Christof Leuenberger <christof.leuenberger@gmail.com >
Signed-off-by: e553956 <christof.leuenberger@sbb.ch >
Signed-off-by: Christof Leuenberger <christof.leuenberger@gmail.com >
Fix typo in mcdocs
Signed-off-by: Christof Leuenberger <christof.leuenberger@gmail.com >
Signed-off-by: e553956 <christof.leuenberger@sbb.ch >
Add requested changes
- Use filename titles for code blocks
- Link to documentation on how to add a component to catalog
- Consistent use of quotes and file endings
Signed-off-by: Christof Leuenberger <christof.leuenberger@gmail.com >
Signed-off-by: e553956 <christof.leuenberger@sbb.ch >
Add mandatory owner field to example
Signed-off-by: Christof Leuenberger <christof.leuenberger@gmail.com >
Signed-off-by: e553956 <christof.leuenberger@sbb.ch >
Fix prettier issues
Signed-off-by: e553956 <christof.leuenberger@sbb.ch >
2023-12-08 16:39:42 +01:00
Fredrik Adelöw
06d5cf944a
Merge pull request #21277 from Ninosaurier/doc-update-disable-font
...
Update how-to-guides.md
2023-12-04 12:12:44 +01:00
Andre Wanlin
c8e253a2e8
Update docs/features/techdocs/how-to-guides.md
...
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com >
2023-12-02 06:12:01 -06:00
Larry Knott
d5f0e991ea
Better link fix
...
Signed-off-by: Larry Knott <larry.knott@autodesk.com >
2023-11-27 14:01:23 -08:00
knottAutodesk
4050f7776b
Update api.md
...
The link to `The Life of an Entity` was broken.
Signed-off-by: knottAutodesk <143034967+knottAutodesk@users.noreply.github.com >
2023-11-27 12:16:35 -08:00
Andre Wanlin
e9e57add1b
Merge pull request #21403 from hainenber/support-additional-mkdocs-server-cli-params
...
Support additional mkdocs server cli params
2023-11-24 10:31:55 -06:00
hainenber
716dd37404
fix(pkg/techdocs): correct dirtyreload arg for mkdocs
...
Also correct array-like elements for rest operator
Signed-off-by: hainenber <dotronghai96@gmail.com >
2023-11-21 22:37:02 +07:00
Edoardo Dusi
859dd0745f
docs: fix GitHub Discovery link in adding-templates.md
...
Signed-off-by: Edoardo Dusi <edo@edoardodusi.com >
2023-11-20 18:00:49 +01:00
Patrik Oldsberg
fc92656e42
Merge pull request #20738 from akz08/add-docker-useroptions-bypass
...
Add a way to bypass user modification for TechDocs CLI docs generation in Docker
2023-11-20 17:41:14 +01:00
hainenber
69b2f7bf3b
fix(techdocs-cli): limit supported mkdocs flags
...
Signed-off-by: hainenber <dotronghai96@gmail.com >
2023-11-20 21:46:41 +07:00
hainenber
549ca5e3c4
fix(pkg/techdocs-cli): specify new opt
...
Signed-off-by: hainenber <dotronghai96@gmail.com >
2023-11-20 21:23:10 +07:00
Antonino Provenzano
286b6f90c3
Update how-to-guides.md
...
Removed "note:". It was a mistake
Signed-off-by: Antonino Provenzano <provenzano.a@gmx.net >
2023-11-17 15:13:31 +01:00
Antonino Provenzano
01594ee027
Update docs/features/techdocs/how-to-guides.md
...
Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com >
Signed-off-by: Antonino Provenzano <provenzano.a@gmx.net >
2023-11-17 13:46:12 +01:00
Deepankumar
52050ada6e
SingleTenant ServiceLocatorMethod for Kubernetes cluster by entity annotation ( #20954 )
...
* Filter Kubernetes cluster by entity annotation
Signed-off-by: Deepankumar Loganathan <deepan0433@gmail.com >
* Documentation updated
Signed-off-by: Deepankumar Loganathan <deepan0433@gmail.com >
* SingleTenantLocator implemented
Signed-off-by: Deepankumar Loganathan <deepan0433@gmail.com >
* API reports updated
Signed-off-by: Deepankumar Loganathan <deepan0433@gmail.com >
* spelling corrected
Signed-off-by: Deepankumar Loganathan <deepan0433@gmail.com >
* document updated and fixed review comments
Signed-off-by: Deepankumar Loganathan <deepan0433@gmail.com >
---------
Signed-off-by: Deepankumar Loganathan <deepan0433@gmail.com >
2023-11-15 14:54:22 -05:00
Fredrik Adelöw
3d61cb0b6a
Merge pull request #20214 from mecseid/feature/implement-gitea-readtree
...
Implement readTree of Gitea provider to support Techdocs
2023-11-15 10:13:24 +01:00
Patrik Oldsberg
0c4e5b6c6e
Merge pull request #20681 from alexashley/node-20-no-snapshots-flag
...
docs: mention flag for using software templates on Node 20
2023-11-14 19:58:15 +01:00
Patrik Oldsberg
af26c3480f
Merge pull request #20941 from waldi/patch-1
...
Fix typo and grammer in features/software-catalog/configuration.md
2023-11-14 13:47:26 +01:00
Antonino Provenzano
52fff5ed0b
Update how-to-guides.md
...
Added new section in doc, to prevent download of Google fonts
Signed-off-by: Antonino Provenzano <provenzano.a@gmx.net >
2023-11-14 10:49:21 +01:00
blam
c5ffd65321
docs: fix
...
Signed-off-by: blam <ben@blam.sh >
2023-11-14 09:29:42 +01:00
blam
c639c7d1e3
docs: added a note
...
Signed-off-by: blam <ben@blam.sh >
2023-11-14 09:20:39 +01:00
blam
a9866f0137
docs: updating some docs for scaffolder
...
Signed-off-by: blam <ben@blam.sh >
2023-11-14 09:15:25 +01:00
Fredrik Adelöw
56f90b09a9
Merge pull request #20984 from backstage/vinzscam/templates-docs
...
Docs: expand section on catalog integrations
2023-11-07 10:35:20 +01:00
Jenson3210
df40b067e1
Kubernetes: Resource quotas as default objects ( #20951 )
...
* Fixed the lack of `resourcequotas`
Signed-off-by: Jente Sondervorst <jentesondervorst@gmail.com >
* Fixed the lack of `resourcequotas`
Signed-off-by: Jente Sondervorst <jentesondervorst@gmail.com >
* Fixed the lack of `resourcequotas`
Signed-off-by: Jente Sondervorst <jentesondervorst@gmail.com >
* Fixed the lack of `resourcequotas`
Signed-off-by: Jente Sondervorst <jentesondervorst@gmail.com >
---------
Signed-off-by: Jente Sondervorst <jentesondervorst@gmail.com >
2023-11-06 16:13:59 -05:00
Vincenzo Scamporlino
c038626c05
docs: expand section on catalog integrations
...
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com >
2023-11-06 13:26:05 +01:00
Waldi
2d8e4ac7b4
Fix typo and grammer in features/software-catalog/configuration.md
...
Signed-off-by: Waldi <barbewaldemar@googlemail.com >
2023-11-02 17:00:10 +01:00
Alex Crome
11153a019d
Merge remote-tracking branch 'upstream/master' into entra-rename
2023-10-28 10:39:42 +01:00
Kamil Zainal
20005cf26d
Update techdocs cli docs
...
Signed-off-by: Kamil Zainal <gh@akza.dev >
2023-10-23 15:11:08 +01:00
Alex Crome
243c655a68
Updated Azure Active Directory to Entra ID
...
Microsoft have renamed Azure Active Directory to Entra ID. https://learn.microsoft.com/en-us/azure/active-directory/fundamentals/new-name . This PR updates references to AAD to refer to Entra ID.
* On each documentation page, I include `formerly Azure Active Directory` in the first non heading reference to Entra ID. This will help anyone unfaimiliar withthe name change, and will also mean the page continues to show up in search results if people search for the old name.
* I didn't correct references in file names, as this would cause broken links. If we have a way of redirecting those to new urls I can look at doign that, but if not, I think it's better to leave existing links working.
* There were a few references to AAD in release notes for older versions - I left these alone as the product naming was correct at the time of the release notes.
* LDAP provider still has references to "Active Directory" as these reference to the on premise Active Directory, not Azure Active Directory
Signed-off-by: Alex Crome <afscrome@users.noreply.github.com >
2023-10-19 23:11:35 +01:00
Alex Ashley
59db162d4b
docs: mention flag for using software templates on Node 20
...
Signed-off-by: Alex Ashley <alexa@liatrio.com >
2023-10-19 09:56:57 -04:00
Hannes Jetter
f268d81a93
Merge branch 'backstage:master' into master
2023-10-19 08:51:45 +02: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
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
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
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
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