Commit Graph

1618 Commits

Author SHA1 Message Date
Daniel Deloff 471b212f85 merged in master
Signed-off-by: Daniel Deloff <44780793+rv-ddeloff@users.noreply.github.com>
2021-10-12 11:54:27 -04:00
Daniel Deloff 044a4511eb adds docs, fixes plugin
Signed-off-by: Daniel Deloff <44780793+rv-ddeloff@users.noreply.github.com>
2021-10-12 11:30:12 -04:00
Eric Peterson bcdee188db Merge pull request #7501 from backstage/docs/analytics
[Documentation] Document the Analytics API
2021-10-12 17:23:10 +02:00
Johan Haals 22bd35917b Merge pull request #7561 from anisorigin/patch-1
change appId: 1 to appId: app id in the docs
2021-10-12 13:59:54 +02:00
Suzanne Daniels b34a8365b1 Prettier changes 2021-10-12 10:53:41 +02:00
Johan Haals 55bd7fd0e9 Merge pull request #7495 from backstage/jhaals/changesets
Add changeset best practices
2021-10-12 09:30:39 +02:00
Morgan Martinet a982e166c5 Enable customization of services used by the kubernetes backend plugin
Signed-off-by: Morgan Martinet <morgan@mmm-experts.com>
2021-10-12 00:59:04 -04:00
anisorigin 805970befe change appId: 1 to app id. 2021-10-12 12:45:20 +10:00
Emma Indal 56bd537256 [Search] add search api how to guide + search bar custom placeholder (#7535) 2021-10-11 21:55:42 +02:00
Aldira Putra Raharja 2bacec5531 Rephrase docs to match descriptions from the official docs
Signed-off-by: Aldira Putra Raharja <dira.thea@gmail.com>
2021-10-11 22:16:02 +07:00
Aldira Putra Raharja 17fdd3aea4 Update docs regarding caData config
Signed-off-by: Aldira Putra Raharja <dira.thea@gmail.com>
2021-10-11 22:05:04 +07:00
Colton Padden d207f6ee9e Support optional bucketRootPath in GCS and S3 techdocs publishers
- Updated app-config.yaml with additional configuration parameters:
    - techdocs.publisher.awsS3.bucketRootPath
    - techdocs.publisher.googleGcs.bucketRootPath
- Updated `fromConfig` and constructors to support additional `bucketRootPath`
  parameters.
- Updated publish method to support `bucketRootPath` in constructing destination
  file path
- Updated `fetchTechDocsMetadata` to use `bucketRootPath`
- Updated `docsRouter` to use `docsRouter` when retrieving files
    - When using both legacy casing, and a bucket root path, additional logic
      was added to prevent the root path's case from being modified as
      previously legacy casing would be applied to the first three entities of
      the URI
- Updated `hasDocsBeenGenerated` to use `bucketRootPath`
- Added additional unit tests for new configurations to updated, and new methods

Signed-off-by: Colton Padden <colton.padden@fastmail.com>
2021-10-11 10:49:40 -04:00
Emma Indal 25a593234b [Search] Update search readme (#7536)
* update list of supported search engines

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* update list of supported plugins integrated to search

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* update feedback link

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* fix links

Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-10-11 14:42:54 +02:00
Suzanne Daniels df0ba2bb02 Update docs/getting-started/index.md
Co-authored-by: Tim Hansen <timbonicus@gmail.com>
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-10-11 13:53:34 +02:00
Suzanne Daniels 6859c42db9 Update docs/getting-started/index.md
Co-authored-by: Tim Hansen <timbonicus@gmail.com>
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-10-11 13:53:34 +02:00
Johan Haals d0dba0a448 place example in indented code block
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2021-10-11 11:26:49 +02:00
Patrik Oldsberg 7f2d184eb4 docs: add implementation section to extending the catalog model
Co-authored-by: Johan Haals <johan.haals@gmail.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-10-10 20:36:01 +02:00
Patrik Oldsberg 9faf634497 Merge pull request #7491 from backstage/rugvip/tooling
docs: rename CLI section to Tooling + move in package linking docs
2021-10-10 20:00:15 +02:00
Patrik Oldsberg 490a905199 docs: rename CLI section to Local Development + move in linking docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-10-09 11:41:37 +02:00
Ben Lambert ce6387a40b Merge pull request #7428 from backstage/hhogg/adr-date-formatting
docs(ADR): Added ADR for using Luxons toLocaleString and date presets
2021-10-08 15:35:14 +02:00
Harry Hogg 25c0779443 docs(ADR): Added ADR for using Luxons toLocaleString and date presets
Signed-off-by: Harry Hogg <hhogg@spotify.com>
2021-10-08 11:48:50 +01:00
Eric Peterson b00e564385 Document the Analytics API.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-10-07 20:26:44 +02:00
Eric Peterson 79d0c0f4c4 Remove existing GA 'integration' docs.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-10-07 20:26:44 +02:00
Adam Harvey bf6c664357 Reword sentence based on feedback
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-10-07 12:45:31 -04:00
Adam Harvey f90b0a421a Fix bullet
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-10-07 12:42:13 -04:00
Suzanne Daniels e27844cd07 Prettierified index.md
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-10-07 18:14:29 +02:00
Suzanne Daniels 11cc634c08 Fixing typo in contributors
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-10-07 17:27:56 +02:00
Suzanne Daniels 9daaf366c1 Delete imgs
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-10-07 17:20:30 +02:00
Suzanne Daniels 91ae05b8ec rename img to match styleguide
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-10-07 17:20:30 +02:00
Suzanne Daniels bd6f4fb2d9 Getting started guide rewrite
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-10-07 17:20:30 +02:00
Johan Haals c3b29843b2 Update docs/getting-started/contributors.md
Signed-off-by: Johan Haals <johan.haals@gmail.com>

Co-authored-by: Adam Harvey <adaharve@cisco.com>
2021-10-07 16:23:06 +02:00
Adam Harvey 9ac7f7c891 Fix typo & update here links
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-10-07 09:44:48 -04:00
Adam Harvey 7d2899c06b Minor editoral tweaks (punctuation, etc.)
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-10-07 09:41:32 -04:00
Johan Haals 888b970498 Add docs for writing changesets
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2021-10-07 14:48:25 +02:00
Fredrik Adelöw 1753974597 Continuing the legacy deprecation journey
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-10-06 21:24:05 +02:00
Ben Lambert e9c591dde5 Merge pull request #7445 from backstage/orkohunter/add-backend-suffix-to-graphql
chore: Add `-backend` suffix to plugins/graphql
2021-10-06 14:01:29 +02:00
Patrik Oldsberg c2512887a6 Merge pull request #7308 from FilipSwiatczak/bitbucket-auth
Bitbucket cloud authentication
2021-10-05 17:06:42 +02:00
Ben Lambert 48a779e14f Merge pull request #7369 from mstergianis/docs/proxying-tutorial
Create a proxying tutorial
2021-10-05 17:06:27 +02:00
Ben Lambert 8111cbe713 Merge pull request #7417 from backstage/rugvip/migrone
docs: migrate composability migration docs away from migration
2021-10-05 12:02:58 +02:00
Himanshu Mishra 3b5d494213 docs: update link to plugins/graphql-backend
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-10-05 11:16:30 +02:00
blam bae5cefc8f chore: revert docs again
Signed-off-by: blam <ben@blam.sh>
2021-10-05 11:15:23 +02:00
Patrik Oldsberg 670f79ded3 Apply suggestions from code review
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-10-04 23:19:23 +02:00
Michael Stergianis a422339a54 Update proxying tutorial to address feedback
Signed-off-by: Michael Stergianis <mstergianis@vmware.com>
2021-10-04 15:11:54 -04:00
Patrik Oldsberg 185fec5c0c cli: add support for using the default jest config from project roots
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-10-02 18:47:20 +02:00
Patrik Oldsberg fddfb5e10f docs: migrate composability migration docs away from migration
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-10-01 18:55:09 +02:00
Patrik Oldsberg da7019019e Merge pull request #7378 from backstage/emmaindal/custom-techdocs-header
[TechDocs] Support custom TechDocs Reader Page
2021-09-30 13:37:09 +02:00
Emma Indal 1f73801d05 replace entityId with entityRef
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-30 12:21:10 +02:00
Emma Indal 89091104a0 update how to guide to cover customize the full reader page
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-29 19:10:15 +02:00
Emma Indal 37822d0740 add example in how to guide of Header without access to metadata
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-29 19:10:15 +02:00
Emma Indal 280954b5c0 add how-to guide for how to use a custom header
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-29 19:10:15 +02:00