Commit Graph

46 Commits

Author SHA1 Message Date
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
Camila Belo c0e64a685f test(techdocs-cli): kill detached child process
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-11-16 20:45:30 +01:00
Camila Belo 04fdd489f6 test(techdocs-cli): fix errors on windows
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-11-15 09:15:14 +01:00
Camila Belo 59a3b58805 fix(techdocs-cli): cross-platform build script
Co-authored-by: Emma Indal <emma.indahl@gmail.com>
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-11-14 15:46:27 +01:00
Camila Belo eec57229eb fix(techdocs-cli): remove quote from volume
Ref: https://github.com/backstage/techdocs-cli/pull/162
Co-authored-by: Emma Indal <emma.indahl@gmail.com>
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-11-12 11:51:34 +01:00
Camila Belo 0456b73da8 fix(techdocs-cli): config file for development build
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-11-11 19:36:38 +01:00
Camila Belo 7a3c2f9301 fix(techdocs-cli): wait for child process to finish
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2021-11-11 19:33:03 +01:00
Andrew Thauer 71e7b0ee92 refactor: reunification of techdocs-cli and backstage repos
Signed-off-by: Andrew Thauer <athauer@wealthsimple.com>
2021-11-11 19:31:55 +01:00
Himanshu Mishra e677dbd3c0 Move techdocs-cli to backstage/techdocs-cli repository 2020-11-05 15:27:14 +01:00
Patrik Oldsberg 468d4a2dae Merge pull request #2684 from themousepotato/lintrule-dirname-fix
Add a lint rule to avoid using __dirname
2020-10-09 21:03:13 +02:00
Navaneeth Suresh bbeaff9daf Add a lint rule to avoid using __dirname 2020-10-09 15:03:29 +05:30
Oliver Sand 00b5b877b4 fix(techdocs-cli): make techdocs-cli work on Windows (#2779)
$(pwd) won't work outside a Unix shell, so I replaced it with process.cwd(). Then it's not important anymore in which directory the docker command is executed.
2020-10-08 11:53:16 +02:00
Patrik Oldsberg aa265769d2 techdocs-cli: import version from techdocs-cli directly 2020-08-03 21:24:44 +02:00
Emma Indal bf8f6c26aa fix(techdocs-cli): use published techdocs docker container 2020-07-21 11:57:20 +02:00
Sebastian Qvarfordt a49239c6e6 Removed unused package 2020-07-15 11:22:50 +02:00
Bilawal Hameed 353cf5a14f techdocs: implement serve for the techdocs-cli (#1581)
* feat(techdocs-cli): point techdocs export to localhost:3000/api

* feat(techdocs-cli): add http-proxy package

* feat(techdocs-cli): add react-dev-utils package

* feat(techdocs-cli): implement serve and serve:mkdocs commands

* fix: use [module] prefix convention in console.log

* docs: added commands

* wip

* Fix type errors

Co-authored-by: Sebastian Qvarfordt <s.qvarfordt@gmail.com>
2020-07-10 16:01:45 +02:00
Sebastian Qvarfordt eed37376fc Initial techdocs-cli (#1558)
* Initial techdocs-cli

* Run backstage serve and docker container from techdocs cli

* Added documentation for techdocs-cli

* Fix linting

* Builds and export the dev folder of a plugin

* make bin/build executable

* Remove 'src' from files

* fix

* fix: corrected bad rebase

* feat(techdocs-cli): create export in techdocs plugin + clone to cli build

* fix: added support for nodemon

* feat(techdocs-cli): add vercel/serve-handler npm package

* fix: bump eslint-config to 8.0.0 + add prettier-config

* fixup

* fix: add HTTPServer module for serving techdocs-preview-bundle/

* fix: addressed tsc issues (unused import, missing type definition)

Co-authored-by: Bilawal Hameed <bil@spotify.com>
2020-07-09 11:08:19 +02:00
Emma Indal b23a90c4b9 fix(techdocs-cli): export module to fix tsc error 2020-06-22 15:08:53 +02:00
Emma Indal d245aaf39e fix(techdocs-cli): delete unused files 2020-06-22 15:00:51 +02:00
Emma Indal e2c52bafc8 fix(codeowners): change techdocs-cli to packages 2020-06-22 14:51:13 +02:00