Commit Graph

69 Commits

Author SHA1 Message Date
Morgan Bentell 7e2fc35df2 Merge pull request #16519 from JosiahCraw/feature/add-proxy-support-for-techdocs-awsS3
feat: add support for HTTPS proxy for AWS S3 requests in Techdocs
2023-02-27 09:38:39 +01:00
Morgan Bentell 8e465ce52e print the mkdocs output when running the generate command with the --verbose flag
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-02-22 17:18:35 +01:00
Jos Craw ea2bbef1b1 feat: add support for HTTPS proxy for AWS S3 requests in Techdocs
Signed-off-by: Jos Craw <me.joscraw@gmail.com>
2023-02-22 21:52:03 +13:00
Morgan Bentell c5c4c91755 Merge pull request #16290 from nikolaik/fix/techdocs-ipv6
fix(techdocs-cli): Fix proxying to mkdocs
2023-02-14 14:34:22 +01:00
Renan Mendes Carvalho c5d51ad7d4 renaming(mkDocs): To mkdocs
Suggested by kmatyukhin on https://github.com/backstage/backstage/pull/15417

Signed-off-by: Renan Mendes Carvalho <aitherios@gmail.com>
Co-authored-by: Konstantin Matyukhin <kmatyukhin@gmail.com>
2023-02-14 11:16:22 +01:00
Renan Mendes Carvalho d746d81bdd renaming(getMkDocsYml): Renamed to getMkdocsYml
Suggested by kmatyukhin on https://github.com/backstage/backstage/pull/15417

Signed-off-by: Renan Mendes Carvalho <aitherios@gmail.com>
Co-authored-by: Konstantin Matyukhin <kmatyukhin@gmail.com>
2023-02-14 11:16:22 +01:00
Nikolai R Kristiansen 71f8fc209f fix(techdocs-cli): Fix proxying to mkdocs
The domain localhost may point to both 127.0.0.1 and ::1, ipv4 and ipv6
and when node tries to lookup localhost it might prefer ipv6 while mkdocs
is only listening on ipv4. This tells node-proxy to target the ipv4 address
instead of relying on localhost hostname lookup.

Signed-off-by: Nikolai R Kristiansen <nikolai.kristiansen@remarkable.no>
2023-02-10 13:05:42 +01:00
Andre Wanlin 37c17ab92c Handle deleting temportary mkdocs.yml
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-02-08 15:21:29 +01:00
Andre Wanlin c9758fe81e Updated default name and params
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-02-08 15:21:29 +01:00
Andre Wanlin 943c245b6f Updated to use siteOptions object
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-02-08 15:21:29 +01:00
Andre Wanlin 15b6eaf533 Large refactor
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-02-08 15:21:29 +01:00
Ben Lambert d34c565e43 Merge pull request #15633 from backstage/renovate/prettier-2.x-lockfile
chore(deps): update dependency prettier to v2.8.3
2023-02-06 15:14:05 +01:00
Patrik Oldsberg cbe69fa263 fix formatting
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-01-27 12:05:53 +01:00
Albin Halinen Wilén f39c417bbb Fixed techdocs-cli package publish CLI command having the gcsBucketRootPath option misconfigured, previously returning a boolean vs a string
Signed-off-by: Albin Halinen Wilén <git@alphahw.eu>
2023-01-16 10:27:02 +08:00
Albin Halinen Wilén 6e0b6a0d50 Fixed techdocs-cli package publish CLI command missing awsBucketRootPath option
Signed-off-by: Albin Halinen Wilén <git@alphahw.eu>
2023-01-16 10:20:52 +08: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
Morgan Bentell ee36ee8d00 fix logic
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-01-09 16:26:29 +01: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
Patrik Oldsberg 9f2b786fc9 Avoid directly logging error objects
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-01-07 14:15:17 +01:00
Morgan Bentell 38cdc28135 add --preview-app-port option to serve command
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-01-05 17:28:26 +01:00
Morgan Bentell bc18c902a2 clean up and update documentation, changeset and cli-report
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-01-04 15:27:27 +01:00
Morgan Bentell b4db2862a4 Add cli option --preview-app-bundle-path
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-01-04 15:27:26 +01:00
aaronbraundmeier@gmail.com 8015ff1258 inclusive terms
Signed-off-by: aaronbraundmeier@gmail.com <aaronbraundmeier@gmail.com>
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-11-30 12:15:00 +01: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
Fredrik Adelöw 2a6d762539 just some vale fixes
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-10-11 13:10:48 +01:00
Matteo Silvestri 0b2a30dead fixing techdocs-cli Docker client creation
Docker client does not need to be created when --no-docker
option is provided.

If you had DOCKER_CERT_PATH environment variable defined
the Docker client was looking for certificates
and breaking techdocs-cli generate command even with --no-docker
option.

Signed-off-by: Matteo Silvestri <matteosilv@gmail.com>
2022-09-07 15:43:27 +02:00
Fredrik Adelöw aaab1e34da Fix linting errors after #13392
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-08-30 13:44:09 +02:00
Mathias Geat dcbb438e5f feat(techdocs-cli): Allow passing docker extra args to @techdocs/cli serve and serve:mkdocs
Signed-off-by: Mathias Geat <mathias.geat@objectbay.com>
2022-08-01 13:22:01 +02:00
Camila Belo 7ad6bde557 Merge pull request #11839 from namco1992/fix-techdocs-cli-config
techdocs-cli: fix the legacyCopyReadmeMdToIndexMd flag in techdocs-cli generate
2022-06-23 15:53:49 +02:00
Eric Peterson 14ce0d9347 Pull by default, don't pull on --no-pull
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2022-06-15 16:13:01 +02:00
Mengnan Gong a5d73da942 techdocs-cli: fix the legacyCopyReadmeMdToIndexMd flag in techdocs-cli
generate

Signed-off-by: Mengnan Gong <namco1992@gmail.com>
2022-06-03 14:26:51 +08:00
Chris Trombley 201d0d31bb fix(techdocs): update proxy endpoint for serve command
Signed-off-by: Chris Trombley <ctrombley@gmail.com>
2022-05-11 11:38:43 -07:00
Fredrik Adelöw 344ea56acc Bump commander to version 9.1.0
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-04-11 09:33:18 +02:00
Eric Peterson efe33862b4 Merge pull request #10403 from carlo-colombo/master
[TechDocs] Adds a flag to the cli to override the entrypoint of a custom docker image. It could be used to reuse existing images with different entrypoints.
2022-04-06 09:34:35 +02:00
Carlo Colombo eb470ea54c Adds a flag to the cli to override the entrypoint of a custom docker image. It could be used to reuse existing images with different eentrypoints.
Signed-off-by: Carlo Colombo <carlo.colombo@klarna.com>
2022-04-06 08:49:32 +02:00
Phil Kuang 9ab9ce617e fix(techdocs): do not copy docs/README.md as docs/index.md
Signed-off-by: Phil Kuang <pkuang@factset.com>
2022-04-04 12:57:38 -04:00
Patrik Oldsberg bd87e805c0 techdocs-cli: tweak e2e test setup
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-03-07 15:37:04 +01:00
Patrik Oldsberg 72fa341eb5 packages,plugins: tweak migrated lint configurations
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-03-07 15:28:01 +01:00
Eric Peterson 91bf1e6c1a Use @backstage/plugin-techdocs-node instead of @backstage/techdocs-common
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2022-03-04 09:54:19 +01:00
Jussi Hallila ff0a16fb1a Add techdocs-core plugin to techdocs builder automatically
Currently users need to modify their mkdocs files to container techdocs-core plugin manually when they want to expose techdocs in Backstage. To have a standardized set of extensions without the need to modify existing files (and possibly pollute alternative/additional mkdocs pipelines) this should be added automatically.

This PR adds a helper function to modify the mkdocs file to contain this plugin if it doesn't exist in the config file.

Co-authored-by: @emmaindal

Signed-off-by: Jussi Hallila <jussi@hallila.com>
2022-03-01 08:20:40 +01:00
Emma Indal f6666642d2 Merge pull request #9546 from backstage/emmaindal/techdocs-cli-tests
[TechDocs CLI] adding cypress testing
2022-02-21 15:54:53 +01:00
Emma Indal 2c2c52426e make Vale linter happy
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2022-02-18 15:20:24 +01:00
Emma Indal a6352f90ea update docs based on new example documentation
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2022-02-18 14:46:21 +01:00
Emma Indal 77a13948c1 add example docs
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2022-02-18 14:40:32 +01:00
Patrik Oldsberg 209fd128e6 removed all references to the removed SCM-specific location types
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-02-17 17:46:04 +01:00
Patrik Oldsberg 814a3ff480 techdocs-cli: switch to embedding app using prepack script
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-02-05 14:00:31 +01:00
Patrik Oldsberg b70c186194 techdocs-cli: unified dev and production build through config detection
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-02-05 14:00:30 +01:00
Otto Sichert 97b8c8c8fc Ensure all relevant port references are updated and document changes
Signed-off-by: Otto Sichert <git@ottosichert.de>
2021-11-18 17:23:43 +01:00
therynamo 3f7931bedc feat: Allow SSE For S3 Buckets
Signed-off-by: therynamo <theryn.groetken@gemini.com>
2021-11-17 14:05:57 -06:00
Colton Padden b41e8f158c Support bucketRootPath configuration for AWS and GCS in publish commands
Introduces command options `--awsBucketRootPath` and `--gcsBucketRootPath` which
map to respective publisher configurations, allowing users to upload files to S3
and GCS in a non-root directory.

Signed-off-by: Colton Padden <colton.padden@fastmail.com>
2021-11-17 08:48:28 -05:00