Commit Graph

1128 Commits

Author SHA1 Message Date
Johan Haals 7a23cdfa59 Update image links to use markdown syntax
Co-authored-by: Ben Lambert <ben@blam.sh>
Co-authored-by: Fredrik Adelöw <freben@users.noreply.github.com>
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2023-02-21 11:43:14 +01:00
MaeIsBad 00e67af342 Fix spelling mistake in techdocs
Signed-off-by: MaeIsBad <26093674+MaeIsBad@users.noreply.github.com>
2023-02-20 09:51:06 +01:00
blam 32a273d78d chore: fixing code block in sidebar
Signed-off-by: blam <ben@blam.sh>
2023-02-16 19:36:36 +01:00
blam 3e8e40ae2c chore: woops, wrong version
Signed-off-by: blam <ben@blam.sh>
2023-02-14 16:54:34 +01:00
Patrik Oldsberg e900342bb6 Apply suggestions from code review
Co-authored-by: Phil Kuang <pkuang@factset.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-02-14 13:56:58 +01:00
blam be4474135a chore: make vale and @kuangp happy :D
Signed-off-by: blam <ben@blam.sh>
2023-02-14 13:56:58 +01:00
blam 14916877dd docs: added some documentation about how to test the alpha version of the scaffolder
Signed-off-by: blam <ben@blam.sh>
2023-02-14 13:56:58 +01:00
Adam Harvey 7bd24b919c chore: Link on page reference to diagram
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2023-02-13 21:20:50 -05:00
Adam Harvey f52b9828fa fix: Missing headers
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2023-02-13 21:13:31 -05:00
Patrik Oldsberg 1b8683ff5d Merge pull request #16046 from jamieklassen/document-proxy-endpoint
Document the proxy endpoint
2023-02-12 21:13:53 +01:00
Matthew Thomas adf027d6c0 docs: add custom action plugin for snyk import
Signed-off-by: Matthew Thomas <matthewthomasgb@gmail.com>
2023-02-09 18:34:38 +00:00
Jamie Klassen 7126b48d6a update known issues since #16018 was fixed
Signed-off-by: Jamie Klassen <jklassen@vmware.com>
2023-02-08 13:31:49 -05:00
Jamie Klassen 05c26fd475 remove relative links
Otherwise, `scripts/verify-links.js` will fail.

Signed-off-by: Jamie Klassen <jklassen@vmware.com>
2023-02-08 13:28:21 -05:00
Jamie Klassen a53d06afe5 Document the proxy endpoint
Signed-off-by: Jamie Klassen <jklassen@vmware.com>
2023-02-08 13:28:20 -05:00
Waldir Montoya 2f31d45f06 Add Organizational and Other headers
Signed-off-by: Waldir Montoya <wmontoya@vmware.com>
2023-02-08 11:47:13 -05:00
Waldir Montoya f68306c494 Merge branch 'backstage:master' into master 2023-02-08 10:00:29 -05:00
Patrik Oldsberg 0debdc983c Merge pull request #16036 from sang-w0o/patch-1
Specify RUN location for installing mkdocs dependencies.
2023-02-08 14:25:13 +01:00
Waldir Montoya e991a3bf99 Merge branch 'backstage:master' into master 2023-02-06 19:39:30 -05:00
David Weber 4660b63947 feat: add TechDocs addon LightBox
Signed-off-by: David Weber <david.weber@w3tec.ch>
2023-02-06 19:38:19 +01:00
Amritpal Nagra 855be5bf86 update url to point to new docs
Signed-off-by: Amritpal Nagra <amritpalnagrame@gmail.com>
2023-02-03 14:34:58 +05:30
Amritpal Nagra f9ae9c3aa5 change hyper link text to be descriptive, rather than as text
Signed-off-by: Amritpal Nagra <amritpalnagrame@gmail.com>
2023-02-03 14:34:21 +05:30
Waldir Montoya 560fd3e6ae Update the ecosystem model section of the docs
Signed-off-by: Waldir Montoya <wmontoya@vmware.com>
2023-02-02 21:19:02 -05:00
Emma Indal ce1220a4b8 support custom list item props on search extensions
Co-authored-by: Camila Belo <camilaibs@gmail.com>
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2023-02-02 09:36:30 +01:00
Fredrik Adelöw d9c8720dd4 just some comment cleanup
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2023-02-01 13:52:06 +01:00
나상우(Roy) db77ab2869 Update version of mkdocs-techdocs-core to most recent version.
Signed-off-by: 나상우(Roy) <robbyra@gmail.com>
2023-01-30 10:58:18 +09:00
나상우(Roy) fcbd3d72fb Speficy RUN location for installing mkdocs dependencies.
Signed-off-by: 나상우(Roy) <robbyra@gmail.com>
2023-01-30 10:47:43 +09:00
lloydchang 96db35f389 docs(using-cloud-storage.md): fix very minor typo
remove extra period

Signed-off-by: lloydchang <lloydchang@gmail.com>
2023-01-29 07:32:36 -08:00
Camila Belo f5fbd82b1d docs(search): update official page
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2023-01-28 10:05:15 +01:00
Patrik Oldsberg 7da1e89547 Merge pull request #15799 from SayakMukhopadhyay/custom-field-ext-docs
docs: fix wrong identifiers in software template
2023-01-27 13:23:12 +01:00
나상우(Roy) 3ea29add12 Add missing finishing single quote.
Signed-off-by: 나상우(Roy) <robbyra@gmail.com>
2023-01-27 17:16:35 +09:00
Fredrik Adelöw a0871a3c0a Merge pull request #15142 from IlyaSavich/catalog-collator-refactoring
Refactor catalog collator
2023-01-25 10:47:58 +01:00
Ben Lambert 2d20b6dd65 Merge pull request #15761 from namco1992/mengnan/imporve-kube-doc
[Kubernetes Plugin] Update the Kubernetes plugin documentation
2023-01-24 11:09:20 +01:00
Ben Lambert 834ac839b4 Update docs/features/kubernetes/configuration.md
Signed-off-by: Ben Lambert <blam@spotify.com>
2023-01-24 10:53:04 +01:00
Sayak Mukhopadhyay 0eebcb20c4 fix: field extensions with correct CSS and HTML
Signed-off-by: Sayak Mukhopadhyay <mukhopadhyaysayak@gmail.com>
2023-01-21 10:48:50 +05:30
Sayak Mukhopadhyay 783eb151a2 fix: docs with wrong identifiers
Signed-off-by: Sayak Mukhopadhyay <mukhopadhyaysayak@gmail.com>
2023-01-21 10:48:48 +05:30
Mengnan Gong c59a5e114a Improve the Kubernetes plugin documentation
- Add the `objectTypes` config
- Add the access needed to fetch pod metrics in the RBAC chapter

Signed-off-by: Mengnan Gong <namco1992@gmail.com>
2023-01-16 18:36:52 +08:00
Ilya Savich 860b1c0902 Move authorization and location back, make transformer as a function
Signed-off-by: Ilya Savich <isavich@box.com>
2023-01-13 17:28:27 +01:00
Fredrik Adelöw c1642b2dd1 some slight additions to the catalog model extension docs
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2023-01-11 10:47:04 +01:00
Eric Peterson 1d66a11acb Merge pull request #15634 from backstage/search/new-client-docs
[Search] Clean up / improve ES client instantiation docs
2023-01-10 14:29:05 +01:00
Eric Peterson ec2d3935b3 Clarify type generics in docs
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2023-01-10 13:45:56 +01:00
Morgan Bentell e7a3ab0b86 Merge pull request #15559 from agentbellnorm/provide-embedded-app-bundle
[TechDocs] Allow user to provide embedded app bundle and specify port
2023-01-10 10:55:52 +01:00
Ben Lambert bbf9ee0e8c Merge pull request #15603 from padupe/docs/update-software-template
docs(docs/features/software-templates/writing-custom-field-extensions.md): update doc with valid example.
2023-01-10 10:06:52 +01:00
Morgan Bentell 794a87c36c remove autoformatting changes
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-01-10 09:52:45 +01:00
Paulo Eduardo Peixoto e85e61c154 docs(docs/features/software-templates/writing-custom-field-extensions.md): change "kehab" to "kebab".
Signed-off-by: Paulo Eduardo Peixoto <pauloeduardo_peixoto@hotmail.com>
2023-01-09 14:16:44 -03:00
Eric Peterson 2a49ffbcb3 Clean up / improve client instantiation docs.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2023-01-09 13:29:39 +01:00
Paulo Eduardo Peixoto a3497ad621 style(docs/features/software-templates/writing-custom-field.extension.md): change style at line 28.
Signed-off-by: Paulo Eduardo Peixoto <pauloeduardo_peixoto@hotmail.com>
2023-01-09 08:18:16 -03:00
Morgan Bentell 29113e760a update docs and clean up
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-01-09 10:03:39 +01:00
Paulo Eduardo Peixoto 7c85508a02 docs(docs/features/software-templates/writing-custom-field-extensions.md): update doc with valid example.
After bug at React.

Signed-off-by: Paulo Eduardo Peixoto <pauloeduardo_peixoto@hotmail.com>
2023-01-05 20:18:45 -03:00
Eric Peterson 503359280e Use correct case when referring to Elasticsearch.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2023-01-05 14:33:15 +01:00
Eric Peterson c2f1041c15 Note limitation about Lunr in production
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2023-01-05 14:32:26 +01:00