Skip to content

Commit c97e2ed

Browse files
committed
remove preview-docs
1 parent 8764965 commit c97e2ed

File tree

20 files changed

+10
-651
lines changed

20 files changed

+10
-651
lines changed

Dockerfile

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@ RUN apk add --no-cache jq git && \
77
npm run prepare && \
88
npm run pack:prepare && \
99
npm install --global redocly-cli.tgz && \
10-
cp packages/cli/src/commands/preview-docs/preview-server/default.hbs \
11-
packages/cli/src/commands/preview-docs/preview-server/hot.js \
12-
/usr/local/lib/node_modules/@redocly/cli/lib/commands/preview-docs/preview-server/ && \
1310
cp packages/cli/src/commands/build-docs/template.hbs \
1411
/usr/local/lib/node_modules/@redocly/cli/lib/commands/build-docs/ && \
1512
# Clean up to reduce image size

__tests__/helpers.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ type CLICommands =
1111
| 'join'
1212
| 'login'
1313
| 'logout'
14-
| 'preview-docs'
1514
| 'check-config'
1615
| 'push'
1716
| 'split'

docs/api-docs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ seo:
77

88
Good quality API documentation is the most important factor for a good developer experience. Redocly offers two options for web-based API reference documentation, so you can choose what fits your needs.
99

10+
<!-- FIXME: needs to be updated as we removing Workflows & preview-docs -->
11+
1012
## API reference
1113

1214
Use the Redocly platform to produce beautiful API documentation, and automatically update it every time your OpenAPI description changes. Change the theme to fit your brand, and make your API consumers very happy with clear documentation, code examples, and the all-important ability to try API calls from within the documentation itself.

docs/commands/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ Documentation commands:
99
- [`preview`](preview.md) Start a local preview of a Redocly project with one of the product NPM packages.
1010
- [`translate`](translate.md) Generate translation keys for a Redocly Realm, Reef, or Revel project.
1111
- [`eject`](eject.md) Eject and modify components from the core theme in a Redocly Realm, Reef, or Revel project.
12-
- [`preview-docs`](preview-docs.md) Preview API reference docs for the specified API description.
1312
- [`build-docs`](build-docs.md) Build API description into an HTML file.
1413

1514
API management commands:

docs/commands/login.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# `login`
22

3+
<!-- FIXME: needs to be updated as we removing the old login & preview-docs -->
4+
35
## Introduction
46

57
Use the `login` command to authenticate to the API registry.

docs/commands/preview-docs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- FIXME: remove? -->
2+
13
# `preview-docs`
24

35
## Introduction

docs/quickstart.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ There's also an [openapi-starter](https://github.com/Redocly/openapi-starter) re
1414

1515
## Preview API documentation
1616

17+
<!-- FIXME: needs to be updated as we removing preview-docs and changing Redoc to openapi-docs -->
18+
1719
Redocly CLI has support for showing a preview of [Redoc](https://redocly.com/redoc/) rendering your API docs, which updates when the API description updates.
1820
Run the command:
1921

docs/sidebars.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@
2626
page: commands/logout.md
2727
- label: preview
2828
page: commands/preview.md
29-
- label: preview-docs
30-
page: commands/preview-docs.md
3129
- label: push
3230
page: commands/push.md
3331
- label: push-status

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@
3232
"bundle": "npm run cli bundle resources/pets.yaml",
3333
"stats": "npm run cli stats resources/pets.yaml",
3434
"split": "npm run cli split resources/pets.yaml -- --outDir output",
35-
"preview": "npm run cli preview-docs resources/pets.yaml",
3635
"build-docs": "npm run cli build-docs resources/pets.yaml",
3736
"benchmark": "node --expose-gc --noconcurrent_sweeping --predictable packages/core/src/benchmark/benchmark.js",
3837
"release": "changeset publish",

packages/cli/package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"engineStrict": true,
1515
"scripts": {
1616
"compile": "tsc",
17-
"copy-assets": "cp src/commands/preview-docs/preview-server/default.hbs lib/commands/preview-docs/preview-server/default.hbs && cp src/commands/preview-docs/preview-server/hot.js lib/commands/preview-docs/preview-server/hot.js && cp src/commands/preview-docs/preview-server/oauth2-redirect.html lib/commands/preview-docs/preview-server/oauth2-redirect.html && cp src/commands/build-docs/template.hbs lib/commands/build-docs/template.hbs ",
17+
"copy-assets": "cp src/commands/build-docs/template.hbs lib/commands/build-docs/template.hbs ",
1818
"prepack": "npm run copy-assets",
1919
"prepublishOnly": "npm run copy-assets && cp ../../README.md ."
2020
},
@@ -46,7 +46,6 @@
4646
"core-js": "^3.32.1",
4747
"dotenv": "^16.4.7",
4848
"form-data": "^4.0.0",
49-
"get-port-please": "^3.0.1",
5049
"glob": "^7.1.6",
5150
"handlebars": "^4.7.6",
5251
"mobx": "^6.0.4",

0 commit comments

Comments
 (0)