paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 40 Packages Projects Releases Wiki Activity

docs: fix npx command for techdocs-cli

Browse Source
This commit is contained in:
Himanshu Mishra
2021-01-10 10:19:45 +01:00
parent d9de82ee6c
commit 0dc2e8a97e
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/techdocs/configuring-ci-cd.md
+4 -4
View File
@@ -24,10 +24,10 @@ REPOSITORY_URL='https://github.com/org/repo'
git clone $REPOSITORY_URL
# Generate
npx techdocs-cli generate --source-dir ./repo --output-dir ./site
npx @techdocs/cli generate --source-dir ./repo --output-dir ./site
# Publish
npx techdocs-cli publish --directory ./site --publisher-type awsS3 --bucket-name <bucket> --entity <Namespace/Kind/Name>
npx @techdocs/cli publish --directory ./site --publisher-type awsS3 --bucket-name <bucket> --entity <Namespace/Kind/Name>
# That's it!
```
@@ -64,7 +64,7 @@ Take a look at
complete command reference, details, and options.
```
npx techdocs-cli generate --no-docker --source-dir PATH_TO_REPO --output-dir ./site
npx @techdocs/cli generate --no-docker --source-dir PATH_TO_REPO --output-dir ./site
```
`PATH_TO_REPO` should be the location where the prepare step above clones the
@@ -83,5 +83,5 @@ necessary authentication environment variables.
- [AWS authentication](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-environment.html)
```
techdocs-cli publish --directory ./site --publisher-type <awsS3|googleGcs> --bucket-name <bucket> --entity <namespace/kind/name>
npx @techdocs/cli publish --directory ./site --publisher-type <awsS3|googleGcs> --bucket-name <bucket> --entity <namespace/kind/name>
```