clean up and update documentation, changeset and cli-report

Signed-off-by: Morgan Bentell <mbentell@spotify.com>
This commit is contained in:
Morgan Bentell
2023-01-04 15:16:39 +01:00
parent b4db2862a4
commit bc18c902a2
6 changed files with 23 additions and 30 deletions
+1
View File
@@ -99,6 +99,7 @@ Options:
--docker-option <DOCKER_OPTION...>
--no-docker
--mkdocs-port <PORT>
--preview-app-bundle-path <PATH_TO_BUNDLE>
-v --verbose
-h, --help
```
-19
View File
@@ -1,19 +0,0 @@
#!/bin/bash
set -e
## build app
cd ~/kod/backstage-frontend/packages/techdocs-cli-embedded-app-4-spotify/
yarn build
## run cli
REPO_ROOT=~/kod/backstage
cd $REPO_ROOT/packages/techdocs-cli/src/
rm -rf dist
cp -r ~/kod/backstage-frontend/packages/techdocs-cli-embedded-app-4-spotify/dist .
cd $REPO_ROOT
yarn workspace @techdocs/cli build
cd ~/kod/docs/
~/kod/backstage/packages/techdocs-cli/bin/techdocs-cli serve --preview-app-bundle-path ~/kod/backstage/packages/techdocs-cli/src/dist
+1 -1
View File
@@ -252,7 +252,7 @@ export function registerCommands(program: Command) {
.option('--mkdocs-port <PORT>', 'Port for MkDocs server to use', '8000')
.option('-v --verbose', 'Enable verbose output.', false)
.option(
'--preview-app-bundle-path <PATH>',
'--preview-app-bundle-path <PATH_TO_BUNDLE>',
'Preview documentation using another web app',
)
.action(lazy(() => import('./serve/serve').then(m => m.default)));
@@ -49,8 +49,6 @@ function getPreviewAppPath(opts: OptionValues): string {
export default async function serve(opts: OptionValues) {
const logger = createLogger({ verbose: opts.verbose });
console.log(opts.previewAppBundlePath);
// Determine if we want to run in local dev mode or not
// This will run the backstage http server on a different port and only used
// for proxying mkdocs to the backstage app running locally (e.g. with webpack-dev-server)