Skip to content

DOC-1545 Remove legacy rapidoc support #319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOC-1545 Remove legacy rapidoc support #319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,14 +196,13 @@ The HTML is controlled by layouts, which are Handlebars templates located in [.p
A layout typically includes partials, located in [.path]_src/partials_, which are reusable template fragments.
Partials may, in turn, include other partials.

This project currently has six layouts:
This project currently has five layouts:

* default.hbs
* 404.hbs
* home.hbs
* index.hbs
* search.hbs
* swagger.hbs

If a page doesn't specify a layout, the `default.hbs` layout is used.

Expand Down
18 changes: 2 additions & 16 deletions gulpfile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ const exportTasks = require('./gulp.d/lib/export-tasks')
const log = require('fancy-log')
const { exec, execSync } = require('child_process')
const path = require('path')
const gulp = require('gulp')

const bundleName = 'ui'
const buildDir = 'build'
Expand All @@ -25,9 +24,6 @@ const glob = {
js: ['gulpfile.js', 'gulp.d/**/*.js', `${srcDir}/{helpers,js}/**/*.js`],
}

const rapidocSrc = 'node_modules/rapidoc/dist/rapidoc-min.js'
const rapidocDest = path.join(srcDir, 'static')

/**
* Compiles Handlebars partial templates by executing a Node.js script for each specified partial.
*
Expand Down Expand Up @@ -55,16 +51,6 @@ function compileWidgets (cb) {
}
}

/**
* Copies the Rapidoc JavaScript file from the source location to the static assets directory.
*
* @returns {Stream} A Gulp stream representing the copy operation.
*/
function copyRapidoc () {
return gulp.src(rapidocSrc)
.pipe(gulp.dest(rapidocDest))
}

const cleanTask = createTask({
name: 'clean',
desc: 'Clean files and folders generated by build',
Expand Down Expand Up @@ -144,7 +130,7 @@ const buildWasmTask = createTask({

const bundleBuildTask = createTask({
name: 'bundle:build',
call: series(cleanTask, lintTask, buildWasmTask, bundleReactTask, compileWidgets, copyRapidoc, buildTask),
call: series(cleanTask, lintTask, buildWasmTask, bundleReactTask, compileWidgets, buildTask),
})

const bundlePackTask = createTask({
Expand Down Expand Up @@ -178,7 +164,7 @@ const buildPreviewPagesTask = createTask({
const previewBuildTask = createTask({
name: 'preview:build',
desc: 'Process and stage the UI assets and generate pages for the preview',
call: series(buildWasmTask, copyRapidoc, bundleReactTask, buildTask, buildPreviewPagesTask),
call: series(buildWasmTask, bundleReactTask, buildTask, buildPreviewPagesTask),
})

const previewServeTask = createTask({
Expand Down
Loading
Loading