From 222a8cf5591579c60cbbc050e4d951bf0b93d6b8 Mon Sep 17 00:00:00 2001 From: LiLi Date: Tue, 12 Oct 2021 16:55:59 +0800 Subject: [PATCH 1/5] fix: pulsar version number placeholder Signed-off-by: LiLi --- site2/website-next/docs/io-use.md | 52 +++++++++---------- site2/website-next/docs/schema-manage.md | 8 +-- site2/website-next/docusaurus.config.js | 13 ++--- .../versioned_docs/version-2.7.3/io-use.md | 52 +++++++++---------- .../version-2.7.3/schema-manage.md | 8 +-- .../versioned_docs/version-2.8.0/io-use.md | 52 +++++++++---------- .../version-2.8.0/schema-manage.md | 8 +-- 7 files changed, 93 insertions(+), 100 deletions(-) diff --git a/site2/website-next/docs/io-use.md b/site2/website-next/docs/io-use.md index 04f82c36f0d93..594f68974a40f 100644 --- a/site2/website-next/docs/io-use.md +++ b/site2/website-next/docs/io-use.md @@ -205,7 +205,7 @@ For more information, see [here](io-cli.md#create). -Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/registerSource?version=} +Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/registerSource?version=@pulsar:version_number@} @@ -301,7 +301,7 @@ For more information, see [here](io-cli.md#create-1). -Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/registerSink?version=} +Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/registerSink?version=@pulsar:version_number@} @@ -399,11 +399,11 @@ For more information, see [here](io-cli.md#start). * Start **all** source connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/start|operation/startSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/start|operation/startSource?version=@pulsar:version_number@} * Start a **specified** source connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/start|operation/startSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/start|operation/startSource?version=@pulsar:version_number@} @@ -441,11 +441,11 @@ For more information, see [here](io-cli.md#start-1). * Start **all** sink connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/start|operation/startSink?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/start|operation/startSink?version=@pulsar:version_number@} * Start a **specified** sink connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sourceName/:instanceId/start|operation/startSink?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sourceName/:instanceId/start|operation/startSink?version=@pulsar:version_number@} @@ -557,7 +557,7 @@ For more information, see [here](io-cli.md#get). -Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/getSourceInfo?version=} +Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/getSourceInfo?version=@pulsar:version_number@} @@ -673,7 +673,7 @@ For more information, see [here](io-cli.md#get-1). -Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/getSinkInfo?version=} +Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/getSinkInfo?version=@pulsar:version_number@} @@ -786,7 +786,7 @@ For more information, see [here](io-cli.md#list). -Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/|operation/listSources?version=} +Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/|operation/listSources?version=@pulsar:version_number@} @@ -850,7 +850,7 @@ For more information, see [here](io-cli.md#list-1). -Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/|operation/listSinks?version=} +Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/|operation/listSinks?version=@pulsar:version_number@} @@ -920,11 +920,11 @@ For more information, see [here](io-cli.md#status). * Get the current status of **all** source connectors. - Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName/status|operation/getSourceStatus?version=} + Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName/status|operation/getSourceStatus?version=@pulsar:version_number@} * Gets the current status of a **specified** source connector. - Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/status|operation/getSourceStatus?version=} + Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/status|operation/getSourceStatus?version=@pulsar:version_number@} @@ -1021,11 +1021,11 @@ For more information, see [here](io-cli.md#status-1). * Get the current status of **all** sink connectors. - Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sinkName/status|operation/getSinkStatus?version=} + Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sinkName/status|operation/getSinkStatus?version=@pulsar:version_number@} * Gets the current status of a **specified** sink connector. - Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sourceName/:instanceId/status|operation/getSinkInstanceStatus?version=} + Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sourceName/:instanceId/status|operation/getSinkInstanceStatus?version=@pulsar:version_number@} @@ -1126,7 +1126,7 @@ For more information, see [here](io-cli.md#update). -Send a `PUT` request to this endpoint: {@inject: endpoint|PUT|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/updateSource?version=} +Send a `PUT` request to this endpoint: {@inject: endpoint|PUT|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/updateSource?version=@pulsar:version_number@} @@ -1226,7 +1226,7 @@ For more information, see [here](io-cli.md#update-1). -Send a `PUT` request to this endpoint: {@inject: endpoint|PUT|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/updateSink?version=} +Send a `PUT` request to this endpoint: {@inject: endpoint|PUT|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/updateSink?version=@pulsar:version_number@} @@ -1334,11 +1334,11 @@ For more information, see [here](io-cli.md#stop). * Stop **all** source connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/stopSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/stopSource?version=@pulsar:version_number@} * Stop a **specified** source connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId|operation/stopSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId|operation/stopSource?version=@pulsar:version_number@} @@ -1435,11 +1435,11 @@ For more information, see [here](io-cli.md#stop-1). * Stop **all** sink connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sinkName/stop|operation/stopSink?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sinkName/stop|operation/stopSink?version=@pulsar:version_number@} * Stop a **specified** sink connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkeName/:instanceId/stop|operation/stopSink?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkeName/:instanceId/stop|operation/stopSink?version=@pulsar:version_number@} @@ -1542,11 +1542,11 @@ For more information, see [here](io-cli.md#restart). * Restart **all** source connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/restart|operation/restartSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/restart|operation/restartSource?version=@pulsar:version_number@} * Restart a **specified** source connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/restart|operation/restartSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/restart|operation/restartSource?version=@pulsar:version_number@} @@ -1643,11 +1643,11 @@ For more information, see [here](io-cli.md#restart-1). * Restart **all** sink connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/restart|operation/restartSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/restart|operation/restartSource?version=@pulsar:version_number@} * Restart a **specified** sink connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/:instanceId/restart|operation/restartSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/:instanceId/restart|operation/restartSource?version=@pulsar:version_number@} @@ -1750,7 +1750,7 @@ For more information, see [here](io-cli.md#delete). Delete al Pulsar source connector. -Send a `DELETE` request to this endpoint: {@inject: endpoint|DELETE|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/deregisterSource?version=} +Send a `DELETE` request to this endpoint: {@inject: endpoint|DELETE|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/deregisterSource?version=@pulsar:version_number@} @@ -1823,7 +1823,7 @@ For more information, see [here](io-cli.md#delete-1). Delete a sink connector. -Send a `DELETE` request to this endpoint: {@inject: endpoint|DELETE|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/deregisterSink?version=} +Send a `DELETE` request to this endpoint: {@inject: endpoint|DELETE|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/deregisterSink?version=@pulsar:version_number@} diff --git a/site2/website-next/docs/schema-manage.md b/site2/website-next/docs/schema-manage.md index 650f8935166d0..4a6670687636d 100644 --- a/site2/website-next/docs/schema-manage.md +++ b/site2/website-next/docs/schema-manage.md @@ -286,7 +286,7 @@ Here are examples of the `schema-definition-file` for a JSON schema. -Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/uploadSchem?version=a} +Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/uploadSchem?version=@pulsar:version_number@a} The post payload is in JSON format. @@ -435,7 +435,7 @@ $ pulsar-admin schemas get -Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/getSchem?version=a} +Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/getSchem?version=@pulsar:version_number@a} Here is an example of a response, which is returned in JSON format. @@ -593,7 +593,7 @@ $ pulsar-admin schemas get --version= -Send a `GET` request to a schema endpoint: {@inject: endpoint|GET|/admin/v2/schemas/:tenant/:namespace/:topic/schema/:version|operation/getSchem?version=a} +Send a `GET` request to a schema endpoint: {@inject: endpoint|GET|/admin/v2/schemas/:tenant/:namespace/:topic/schema/:version|operation/getSchem?version=@pulsar:version_number@a} Here is an example of a response, which is returned in JSON format. @@ -779,7 +779,7 @@ $ pulsar-admin schemas delete -Send a `DELETE` request to a schema endpoint: {@inject: endpoint|DELETE|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/deleteSchema?version=} +Send a `DELETE` request to a schema endpoint: {@inject: endpoint|DELETE|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/deleteSchema?version=@pulsar:version_number@} Here is an example of a response, which is returned in JSON format. diff --git a/site2/website-next/docusaurus.config.js b/site2/website-next/docusaurus.config.js index 1c8fdd32c1fcc..709c3f7bb18bf 100644 --- a/site2/website-next/docusaurus.config.js +++ b/site2/website-next/docusaurus.config.js @@ -95,8 +95,8 @@ module.exports = { onBrokenLinks: "ignore", onBrokenMarkdownLinks: "ignore", favicon: "img/favicon.ico", - organizationName: "Apache", - projectName: "Pulsar", + organizationName: "apache", + projectName: "pulsar", themeConfig: { navbar: { title: "", @@ -161,14 +161,7 @@ module.exports = { // theme: lightCodeTheme, // darkTheme: darkCodeTheme, theme: require("prism-react-renderer/themes/dracula"), - additionalLanguages: [ - "powershell", - "java", - "go", - "c", - "cpp", - "python", - ], + additionalLanguages: ["powershell", "java", "go", "c", "cpp", "python"], }, }, presets: [ diff --git a/site2/website-next/versioned_docs/version-2.7.3/io-use.md b/site2/website-next/versioned_docs/version-2.7.3/io-use.md index 79647272e39a0..0123de232f316 100644 --- a/site2/website-next/versioned_docs/version-2.7.3/io-use.md +++ b/site2/website-next/versioned_docs/version-2.7.3/io-use.md @@ -206,7 +206,7 @@ For more information, see [here](io-cli.md#create). -Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/registerSource?version=} +Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/registerSource?version=@pulsar:version_number@} @@ -302,7 +302,7 @@ For more information, see [here](io-cli.md#create-1). -Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/registerSink?version=} +Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/registerSink?version=@pulsar:version_number@} @@ -400,11 +400,11 @@ For more information, see [here](io-cli.md#start). * Start **all** source connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/start|operation/startSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/start|operation/startSource?version=@pulsar:version_number@} * Start a **specified** source connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/start|operation/startSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/start|operation/startSource?version=@pulsar:version_number@} @@ -442,11 +442,11 @@ For more information, see [here](io-cli.md#start-1). * Start **all** sink connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/start|operation/startSink?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/start|operation/startSink?version=@pulsar:version_number@} * Start a **specified** sink connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sourceName/:instanceId/start|operation/startSink?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sourceName/:instanceId/start|operation/startSink?version=@pulsar:version_number@} @@ -558,7 +558,7 @@ For more information, see [here](io-cli.md#get). -Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/getSourceInfo?version=} +Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/getSourceInfo?version=@pulsar:version_number@} @@ -674,7 +674,7 @@ For more information, see [here](io-cli.md#get-1). -Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/getSinkInfo?version=} +Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/getSinkInfo?version=@pulsar:version_number@} @@ -787,7 +787,7 @@ For more information, see [here](io-cli.md#list). -Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/|operation/listSources?version=} +Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/|operation/listSources?version=@pulsar:version_number@} @@ -851,7 +851,7 @@ For more information, see [here](io-cli.md#list-1). -Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/|operation/listSinks?version=} +Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/|operation/listSinks?version=@pulsar:version_number@} @@ -921,11 +921,11 @@ For more information, see [here](io-cli.md#status). * Get the current status of **all** source connectors. - Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName/status|operation/getSourceStatus?version=} + Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName/status|operation/getSourceStatus?version=@pulsar:version_number@} * Gets the current status of a **specified** source connector. - Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/status|operation/getSourceStatus?version=} + Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/status|operation/getSourceStatus?version=@pulsar:version_number@} @@ -1022,11 +1022,11 @@ For more information, see [here](io-cli.md#status-1). * Get the current status of **all** sink connectors. - Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sinkName/status|operation/getSinkStatus?version=} + Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sinkName/status|operation/getSinkStatus?version=@pulsar:version_number@} * Gets the current status of a **specified** sink connector. - Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sourceName/:instanceId/status|operation/getSinkInstanceStatus?version=} + Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sourceName/:instanceId/status|operation/getSinkInstanceStatus?version=@pulsar:version_number@} @@ -1127,7 +1127,7 @@ For more information, see [here](io-cli.md#update). -Send a `PUT` request to this endpoint: {@inject: endpoint|PUT|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/updateSource?version=} +Send a `PUT` request to this endpoint: {@inject: endpoint|PUT|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/updateSource?version=@pulsar:version_number@} @@ -1227,7 +1227,7 @@ For more information, see [here](io-cli.md#update-1). -Send a `PUT` request to this endpoint: {@inject: endpoint|PUT|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/updateSink?version=} +Send a `PUT` request to this endpoint: {@inject: endpoint|PUT|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/updateSink?version=@pulsar:version_number@} @@ -1335,11 +1335,11 @@ For more information, see [here](io-cli.md#stop). * Stop **all** source connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/stopSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/stopSource?version=@pulsar:version_number@} * Stop a **specified** source connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId|operation/stopSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId|operation/stopSource?version=@pulsar:version_number@} @@ -1436,11 +1436,11 @@ For more information, see [here](io-cli.md#stop-1). * Stop **all** sink connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sinkName/stop|operation/stopSink?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sinkName/stop|operation/stopSink?version=@pulsar:version_number@} * Stop a **specified** sink connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkeName/:instanceId/stop|operation/stopSink?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkeName/:instanceId/stop|operation/stopSink?version=@pulsar:version_number@} @@ -1543,11 +1543,11 @@ For more information, see [here](io-cli.md#restart). * Restart **all** source connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/restart|operation/restartSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/restart|operation/restartSource?version=@pulsar:version_number@} * Restart a **specified** source connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/restart|operation/restartSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/restart|operation/restartSource?version=@pulsar:version_number@} @@ -1644,11 +1644,11 @@ For more information, see [here](io-cli.md#restart-1). * Restart **all** sink connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/restart|operation/restartSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/restart|operation/restartSource?version=@pulsar:version_number@} * Restart a **specified** sink connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/:instanceId/restart|operation/restartSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/:instanceId/restart|operation/restartSource?version=@pulsar:version_number@} @@ -1751,7 +1751,7 @@ For more information, see [here](io-cli.md#delete). Delete al Pulsar source connector. -Send a `DELETE` request to this endpoint: {@inject: endpoint|DELETE|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/deregisterSource?version=} +Send a `DELETE` request to this endpoint: {@inject: endpoint|DELETE|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/deregisterSource?version=@pulsar:version_number@} @@ -1824,7 +1824,7 @@ For more information, see [here](io-cli.md#delete-1). Delete a sink connector. -Send a `DELETE` request to this endpoint: {@inject: endpoint|DELETE|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/deregisterSink?version=} +Send a `DELETE` request to this endpoint: {@inject: endpoint|DELETE|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/deregisterSink?version=@pulsar:version_number@} diff --git a/site2/website-next/versioned_docs/version-2.7.3/schema-manage.md b/site2/website-next/versioned_docs/version-2.7.3/schema-manage.md index 47afaedf03a3d..b264f5369572e 100644 --- a/site2/website-next/versioned_docs/version-2.7.3/schema-manage.md +++ b/site2/website-next/versioned_docs/version-2.7.3/schema-manage.md @@ -278,7 +278,7 @@ Here are examples of the `schema-definition-file` for a JSON schema. -Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/uploadSchem?version=a} +Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/uploadSchem?version=@pulsar:version_number@a} The post payload is in JSON format. @@ -423,7 +423,7 @@ $ pulsar-admin schemas get -Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/getSchem?version=a} +Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/getSchem?version=@pulsar:version_number@a} Here is an example of a response, which is returned in JSON format. @@ -577,7 +577,7 @@ $ pulsar-admin schemas get --version= -Send a `GET` request to a schema endpoint: {@inject: endpoint|GET|/admin/v2/schemas/:tenant/:namespace/:topic/schema/:version|operation/getSchem?version=a} +Send a `GET` request to a schema endpoint: {@inject: endpoint|GET|/admin/v2/schemas/:tenant/:namespace/:topic/schema/:version|operation/getSchem?version=@pulsar:version_number@a} Here is an example of a response, which is returned in JSON format. @@ -758,7 +758,7 @@ $ pulsar-admin schemas delete -Send a `DELETE` request to a schema endpoint: {@inject: endpoint|DELETE|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/deleteSchema?version=} +Send a `DELETE` request to a schema endpoint: {@inject: endpoint|DELETE|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/deleteSchema?version=@pulsar:version_number@} Here is an example of a response, which is returned in JSON format. diff --git a/site2/website-next/versioned_docs/version-2.8.0/io-use.md b/site2/website-next/versioned_docs/version-2.8.0/io-use.md index 79647272e39a0..0123de232f316 100644 --- a/site2/website-next/versioned_docs/version-2.8.0/io-use.md +++ b/site2/website-next/versioned_docs/version-2.8.0/io-use.md @@ -206,7 +206,7 @@ For more information, see [here](io-cli.md#create). -Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/registerSource?version=} +Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/registerSource?version=@pulsar:version_number@} @@ -302,7 +302,7 @@ For more information, see [here](io-cli.md#create-1). -Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/registerSink?version=} +Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/registerSink?version=@pulsar:version_number@} @@ -400,11 +400,11 @@ For more information, see [here](io-cli.md#start). * Start **all** source connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/start|operation/startSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/start|operation/startSource?version=@pulsar:version_number@} * Start a **specified** source connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/start|operation/startSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/start|operation/startSource?version=@pulsar:version_number@} @@ -442,11 +442,11 @@ For more information, see [here](io-cli.md#start-1). * Start **all** sink connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/start|operation/startSink?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/start|operation/startSink?version=@pulsar:version_number@} * Start a **specified** sink connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sourceName/:instanceId/start|operation/startSink?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sourceName/:instanceId/start|operation/startSink?version=@pulsar:version_number@} @@ -558,7 +558,7 @@ For more information, see [here](io-cli.md#get). -Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/getSourceInfo?version=} +Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/getSourceInfo?version=@pulsar:version_number@} @@ -674,7 +674,7 @@ For more information, see [here](io-cli.md#get-1). -Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/getSinkInfo?version=} +Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/getSinkInfo?version=@pulsar:version_number@} @@ -787,7 +787,7 @@ For more information, see [here](io-cli.md#list). -Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/|operation/listSources?version=} +Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/|operation/listSources?version=@pulsar:version_number@} @@ -851,7 +851,7 @@ For more information, see [here](io-cli.md#list-1). -Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/|operation/listSinks?version=} +Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/|operation/listSinks?version=@pulsar:version_number@} @@ -921,11 +921,11 @@ For more information, see [here](io-cli.md#status). * Get the current status of **all** source connectors. - Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName/status|operation/getSourceStatus?version=} + Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName/status|operation/getSourceStatus?version=@pulsar:version_number@} * Gets the current status of a **specified** source connector. - Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/status|operation/getSourceStatus?version=} + Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/status|operation/getSourceStatus?version=@pulsar:version_number@} @@ -1022,11 +1022,11 @@ For more information, see [here](io-cli.md#status-1). * Get the current status of **all** sink connectors. - Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sinkName/status|operation/getSinkStatus?version=} + Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sinkName/status|operation/getSinkStatus?version=@pulsar:version_number@} * Gets the current status of a **specified** sink connector. - Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sourceName/:instanceId/status|operation/getSinkInstanceStatus?version=} + Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/:sourceName/:instanceId/status|operation/getSinkInstanceStatus?version=@pulsar:version_number@} @@ -1127,7 +1127,7 @@ For more information, see [here](io-cli.md#update). -Send a `PUT` request to this endpoint: {@inject: endpoint|PUT|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/updateSource?version=} +Send a `PUT` request to this endpoint: {@inject: endpoint|PUT|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/updateSource?version=@pulsar:version_number@} @@ -1227,7 +1227,7 @@ For more information, see [here](io-cli.md#update-1). -Send a `PUT` request to this endpoint: {@inject: endpoint|PUT|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/updateSink?version=} +Send a `PUT` request to this endpoint: {@inject: endpoint|PUT|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/updateSink?version=@pulsar:version_number@} @@ -1335,11 +1335,11 @@ For more information, see [here](io-cli.md#stop). * Stop **all** source connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/stopSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/stopSource?version=@pulsar:version_number@} * Stop a **specified** source connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId|operation/stopSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId|operation/stopSource?version=@pulsar:version_number@} @@ -1436,11 +1436,11 @@ For more information, see [here](io-cli.md#stop-1). * Stop **all** sink connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sinkName/stop|operation/stopSink?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/:tenant/:namespace/:sinkName/stop|operation/stopSink?version=@pulsar:version_number@} * Stop a **specified** sink connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkeName/:instanceId/stop|operation/stopSink?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkeName/:instanceId/stop|operation/stopSink?version=@pulsar:version_number@} @@ -1543,11 +1543,11 @@ For more information, see [here](io-cli.md#restart). * Restart **all** source connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/restart|operation/restartSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/restart|operation/restartSource?version=@pulsar:version_number@} * Restart a **specified** source connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/restart|operation/restartSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sourceName/:instanceId/restart|operation/restartSource?version=@pulsar:version_number@} @@ -1644,11 +1644,11 @@ For more information, see [here](io-cli.md#restart-1). * Restart **all** sink connectors. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/restart|operation/restartSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/restart|operation/restartSource?version=@pulsar:version_number@} * Restart a **specified** sink connector. - Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/:instanceId/restart|operation/restartSource?version=} + Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sources/:tenant/:namespace/:sinkName/:instanceId/restart|operation/restartSource?version=@pulsar:version_number@} @@ -1751,7 +1751,7 @@ For more information, see [here](io-cli.md#delete). Delete al Pulsar source connector. -Send a `DELETE` request to this endpoint: {@inject: endpoint|DELETE|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/deregisterSource?version=} +Send a `DELETE` request to this endpoint: {@inject: endpoint|DELETE|/admin/v3/sources/:tenant/:namespace/:sourceName|operation/deregisterSource?version=@pulsar:version_number@} @@ -1824,7 +1824,7 @@ For more information, see [here](io-cli.md#delete-1). Delete a sink connector. -Send a `DELETE` request to this endpoint: {@inject: endpoint|DELETE|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/deregisterSink?version=} +Send a `DELETE` request to this endpoint: {@inject: endpoint|DELETE|/admin/v3/sinks/:tenant/:namespace/:sinkName|operation/deregisterSink?version=@pulsar:version_number@} diff --git a/site2/website-next/versioned_docs/version-2.8.0/schema-manage.md b/site2/website-next/versioned_docs/version-2.8.0/schema-manage.md index 47afaedf03a3d..b264f5369572e 100644 --- a/site2/website-next/versioned_docs/version-2.8.0/schema-manage.md +++ b/site2/website-next/versioned_docs/version-2.8.0/schema-manage.md @@ -278,7 +278,7 @@ Here are examples of the `schema-definition-file` for a JSON schema. -Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/uploadSchem?version=a} +Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/uploadSchem?version=@pulsar:version_number@a} The post payload is in JSON format. @@ -423,7 +423,7 @@ $ pulsar-admin schemas get -Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/getSchem?version=a} +Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/getSchem?version=@pulsar:version_number@a} Here is an example of a response, which is returned in JSON format. @@ -577,7 +577,7 @@ $ pulsar-admin schemas get --version= -Send a `GET` request to a schema endpoint: {@inject: endpoint|GET|/admin/v2/schemas/:tenant/:namespace/:topic/schema/:version|operation/getSchem?version=a} +Send a `GET` request to a schema endpoint: {@inject: endpoint|GET|/admin/v2/schemas/:tenant/:namespace/:topic/schema/:version|operation/getSchem?version=@pulsar:version_number@a} Here is an example of a response, which is returned in JSON format. @@ -758,7 +758,7 @@ $ pulsar-admin schemas delete -Send a `DELETE` request to a schema endpoint: {@inject: endpoint|DELETE|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/deleteSchema?version=} +Send a `DELETE` request to a schema endpoint: {@inject: endpoint|DELETE|/admin/v2/schemas/:tenant/:namespace/:topic/schema|operation/deleteSchema?version=@pulsar:version_number@} Here is an example of a response, which is returned in JSON format. From 3aa92f120314d66f9c041717b979aa66a366fc18 Mon Sep 17 00:00:00 2001 From: LiLi Date: Tue, 12 Oct 2021 19:13:20 +0800 Subject: [PATCH 2/5] feat: script to replace version info in links Signed-off-by: LiLi --- site2/website-next/docusaurus.config.js | 2 +- site2/website-next/package.json | 5 +- site2/website-next/scripts/docker.sh | 16 ++ site2/website-next/scripts/replace.js | 235 ++++++++++++++++++++++++ 4 files changed, 255 insertions(+), 3 deletions(-) create mode 100755 site2/website-next/scripts/docker.sh create mode 100644 site2/website-next/scripts/replace.js diff --git a/site2/website-next/docusaurus.config.js b/site2/website-next/docusaurus.config.js index 709c3f7bb18bf..23d1a73292a44 100644 --- a/site2/website-next/docusaurus.config.js +++ b/site2/website-next/docusaurus.config.js @@ -91,7 +91,7 @@ module.exports = { tagline: "Apache Pulsar is a cloud-native, distributed messaging and streaming platform originally created at Yahoo! and now a top-level Apache Software Foundation project", url: "https://pulsar.apache.com", - baseUrl: "/", + baseUrl: baseUrl, onBrokenLinks: "ignore", onBrokenMarkdownLinks: "ignore", favicon: "img/favicon.ico", diff --git a/site2/website-next/package.json b/site2/website-next/package.json index d35eed9590528..52ad62fe0617f 100644 --- a/site2/website-next/package.json +++ b/site2/website-next/package.json @@ -24,8 +24,9 @@ "prism-react-renderer": "^1.2.1", "react": "^17.0.2", "react-dom": "^17.0.2", - "url-loader": "^4.1.1", - "remark-linkify-regex": "^1.0.0" + "remark-linkify-regex": "^1.0.0", + "replace-in-file": "^6.2.0", + "url-loader": "^4.1.1" }, "browserslist": { "production": [ diff --git a/site2/website-next/scripts/docker.sh b/site2/website-next/scripts/docker.sh new file mode 100755 index 0000000000000..c181b7013ebd6 --- /dev/null +++ b/site2/website-next/scripts/docker.sh @@ -0,0 +1,16 @@ + +#! /bin/sh + +ROOT_DIR=$(git rev-parse --show-toplevel) +CONTAINER_NAME="website-next" +CONTAINER_ID=$(docker ps | grep $CONTAINER_NAME | awk '{print $1}') + +if [ -n "$CONTAINER_ID" ] +then + docker exec -it $CONTAINER_NAME nginx -s reload +else + docker run --name $CONTAINER_NAME -d -p 80:80 -v $ROOT_DIR/site2/website-next/build:/usr/share/nginx/html nginx +fi + + +echo "Website is running: http://localhost" diff --git a/site2/website-next/scripts/replace.js b/site2/website-next/scripts/replace.js new file mode 100644 index 0000000000000..654eb6a4f97b0 --- /dev/null +++ b/site2/website-next/scripts/replace.js @@ -0,0 +1,235 @@ +const replace = require("replace-in-file"); + +const fs = require("fs"); + +const CWD = process.cwd(); +const siteConfig = require(`${CWD}/docusaurus.config.js`); +const nextDocsDir = `${CWD}/docs`; +const docsDir = `${CWD}/versioned_docs`; + +function getVersions() { + try { + return JSON.parse( + require("fs").readFileSync(`${CWD}/versions.json`, "utf8") + ); + } catch (error) { + //console.error(error) + console.error("no versions found defaulting to 2.1.0"); + } + return ["2.1.0"]; +} + +function downloadPageUrl() { + return `${siteConfig.baseUrl}download`; +} + +function binaryReleaseUrl(version) { + if (version.includes("incubating")) { + return `https://archive.apache.org/dist/incubator/pulsar/pulsar-${version}/apache-pulsar-${version}-bin.tar.gz`; + } else { + return `https://archive.apache.org/dist/pulsar/pulsar-${version}/apache-pulsar-${version}-bin.tar.gz`; + } +} + +function connectorReleaseUrl(version) { + if (version.includes("incubating")) { + return `https://archive.apache.org/dist/incubator/pulsar/pulsar-${version}/apache-pulsar-io-connectors-${version}-bin.tar.gz`; + } else if (version >= "2.3.0") { + return `https://archive.apache.org/dist/pulsar/pulsar-${version}/connectors`; + } else { + return `https://archive.apache.org/dist/pulsar/pulsar-${version}/apache-pulsar-io-connectors-${version}-bin.tar.gz`; + } +} + +function offloaderReleaseUrl(version) { + return `https://archive.apache.org/dist/pulsar/pulsar-${version}/apache-pulsar-offloaders-${version}-bin.tar.gz`; +} + +function prestoPulsarReleaseUrl(version) { + if (version.includes("incubating")) { + return `https://archive.apache.org/dist/incubator/pulsar/pulsar-${version}/pulsar-presto-connector-${version}.tar.gz`; + } else { + return `https://archive.apache.org/dist/pulsar/pulsar-${version}/pulsar-presto-connector-${version}.tar.gz`; + } +} + +function rpmReleaseUrl(version, type) { + rpmVersion = version.replace("incubating", "1_incubating"); + if (version.includes("incubating")) { + return `https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=incubator/pulsar/pulsar-${version}/RPMS/apache-pulsar-client${type}-${rpmVersion}.x86_64.rpm`; + } else { + return `https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=pulsar/pulsar-${version}/RPMS/apache-pulsar-client${type}-${rpmVersion}-1.x86_64.rpm`; + } +} + +function debReleaseUrl(version, type) { + if (version.includes("incubating")) { + return `https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=incubator/pulsar/pulsar-${version}/DEB/apache-pulsar-client${type}.deb`; + } else { + return `https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=pulsar/pulsar-${version}/DEB/apache-pulsar-client${type}.deb`; + } +} + +function rpmDistUrl(version, type) { + rpmVersion = version.replace("incubating", "1_incubating"); + if (version.includes("incubating")) { + return `https://archive.apache.org/dist/incubator/pulsar/pulsar-${version}/RPMS/apache-pulsar-client${type}-${rpmVersion}.x86_64.rpm`; + } else { + return `https://archive.apache.org/dist/pulsar/pulsar-${version}/RPMS/apache-pulsar-client${type}-${rpmVersion}-1.x86_64.rpm`; + } +} + +function debDistUrl(version, type) { + if (version.includes("incubating")) { + return `https://archive.apache.org/dist/incubator/pulsar/pulsar-${version}/DEB/apache-pulsar-client${type}.deb`; + } else { + return `https://archive.apache.org/dist/pulsar/pulsar-${version}/DEB/apache-pulsar-client${type}.deb`; + } +} + +function clientVersionUrl(version, type) { + var versions = version.split("."); + var majorVersion = parseInt(versions[0]); + var minorVersion = parseInt(versions[1]); + if (majorVersion === 2 && minorVersion < 5) { + return `/api/` + type + `/` + version; + } else if (majorVersion >= 2 && minorVersion >= 5) { + return ( + `/api/` + + type + + `/` + + majorVersion + + `.` + + minorVersion + + `.0` + + `-SNAPSHOT` + ); + } +} + +function doReplace(options) { + replace(options) + .then((changes) => { + if (options.dry) { + console.log("Modified files:"); + console.log(changes.join("\n")); + } + }) + .catch((error) => { + console.error("Error occurred:", error); + }); +} + +const versions = getVersions(); + +const latestVersion = versions[0]; +const latestVersionWithoutIncubating = latestVersion.replace("-incubating", ""); + +const from = [ + /@pulsar:version_number@/g, + /@pulsar:version@/g, + /pulsar:binary_release_url/g, + /pulsar:connector_release_url/g, + /pulsar:offloader_release_url/g, + /pulsar:presto_pulsar_connector_release_url/g, + /pulsar:download_page_url/g, + /@pulsar:rpm:client@/g, + /@pulsar:rpm:client-debuginfo@/g, + /@pulsar:rpm:client-devel@/g, + /@pulsar:deb:client@/g, + /@pulsar:deb:client-devel@/g, + + /@pulsar:dist_rpm:client@/g, + /@pulsar:dist_rpm:client-debuginfo@/g, + /@pulsar:dist_rpm:client-devel@/g, + /@pulsar:dist_deb:client@/g, + /@pulsar:dist_deb:client-devel@/g, + + /\/api\/python/g, + /\/api\/cpp/g, + /\/api\/pulsar-functions/g, + /\/api\/client/g, + /\/api\/admin/g, + + /@pulsar:version_number@/g, +]; + +const options = { + files: [`${nextDocsDir}/*.md`, `${nextDocsDir}/**/*.md`], + from: from, + to: [ + `${latestVersionWithoutIncubating}`, + `${latestVersion}`, + binaryReleaseUrl(`${latestVersion}`), + connectorReleaseUrl(`${latestVersion}`), + offloaderReleaseUrl(`${latestVersion}`), + prestoPulsarReleaseUrl(`${latestVersion}`), + downloadPageUrl(), + rpmReleaseUrl(`${latestVersion}`, ""), + rpmReleaseUrl(`${latestVersion}`, "-debuginfo"), + rpmReleaseUrl(`${latestVersion}`, "-devel"), + debReleaseUrl(`${latestVersion}`, ""), + debReleaseUrl(`${latestVersion}`, "-dev"), + + rpmDistUrl(`${latestVersion}`, ""), + rpmDistUrl(`${latestVersion}`, "-debuginfo"), + rpmDistUrl(`${latestVersion}`, "-devel"), + debDistUrl(`${latestVersion}`, ""), + debDistUrl(`${latestVersion}`, "-dev"), + + clientVersionUrl(`${latestVersion}`, "python"), + clientVersionUrl(`${latestVersion}`, "cpp"), + clientVersionUrl(`${latestVersion}`, "pulsar-functions"), + clientVersionUrl(`${latestVersion}`, "client"), + clientVersionUrl(`${latestVersion}`, "admin"), + `${latestVersion}`, + ], + dry: false, +}; + +doReplace(options); + +// TODO activate and test when first version of docs are cut +// replaces versions +for (v of versions) { + if (v === latestVersion) { + continue; + } + const vWithoutIncubating = v.replace("-incubating", ""); + const opts = { + files: [ + `${docsDir}/version-${v}/*.md`, + `${docsDir}/version-${v}/**/*.md`, + // `${docsDir}/en/${v}/*.html`, + // `${docsDir}/en/${v}/**/*.html`, + ], + from: from, + to: [ + `${vWithoutIncubating}`, + `${v}`, + binaryReleaseUrl(`${v}`), + connectorReleaseUrl(`${v}`), + offloaderReleaseUrl(`${v}`), + prestoPulsarReleaseUrl(`${v}`), + downloadPageUrl(), + rpmDistUrl(`${v}`, ""), + rpmDistUrl(`${v}`, "-debuginfo"), + rpmDistUrl(`${v}`, "-devel"), + debDistUrl(`${v}`, ""), + debDistUrl(`${v}`, "-dev"), + rpmDistUrl(`${v}`, ""), + rpmDistUrl(`${v}`, "-debuginfo"), + rpmDistUrl(`${v}`, "-devel"), + debDistUrl(`${v}`, ""), + debDistUrl(`${v}`, "-dev"), + clientVersionUrl(`${v}`, "python"), + clientVersionUrl(`${v}`, "cpp"), + clientVersionUrl(`${v}`, "pulsar-functions"), + clientVersionUrl(`${v}`, "client"), + clientVersionUrl(`${v}`, "admin"), + `${v}`, + ], + dry: false, + }; + doReplace(opts); +} From e9260fe4b1904f653e75089625a5f954810d9abd Mon Sep 17 00:00:00 2001 From: LiLi Date: Tue, 12 Oct 2021 19:43:37 +0800 Subject: [PATCH 3/5] fix: link parse Signed-off-by: LiLi --- site2/website-next/docusaurus.config.js | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/site2/website-next/docusaurus.config.js b/site2/website-next/docusaurus.config.js index 23d1a73292a44..226f485caf0da 100644 --- a/site2/website-next/docusaurus.config.js +++ b/site2/website-next/docusaurus.config.js @@ -58,11 +58,12 @@ const injectLinkParse = ([, prefix, , name, path]) => { }; const injectLinkParseForEndpoint = ([, info]) => { - // console.log("inject link parse: ", info); - const [method, path, suffix] = info.split("|"); - // console.log(method, path ,suffix) + let [method, path, suffix] = info.split("|"); + if (!suffix) { + suffix = path; + } - const restPath = path.split("/"); + let restPath = path.split("/"); const restApiVersion = restPath[2]; const restApiType = restPath[3]; let restBaseUrl = restApiUrl; @@ -74,14 +75,14 @@ const injectLinkParseForEndpoint = ([, info]) => { restBaseUrl = sinkApiUrl; } let restUrl = ""; - if (suffix && suffix.indexOf("?version") >= 0) { + if (suffix.indexOf("?version") >= 0) { restUrl = suffix + "&apiVersion=" + restApiVersion; - } else if (suffix) { + } else { restUrl = suffix + "version=master&apiVersion=" + restApiVersion; } return { text: method + " " + path, - link: restBaseUrl + suffix ? "#" + restUrl : "", + link: restBaseUrl + "#" + restUrl, }; }; From 59e18d9de543a8c2c75addb6d3f9d3f29933f4fc Mon Sep 17 00:00:00 2001 From: LiLi Date: Tue, 12 Oct 2021 19:46:58 +0800 Subject: [PATCH 4/5] fix: replace.js Signed-off-by: LiLi --- site2/website-next/scripts/replace.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/site2/website-next/scripts/replace.js b/site2/website-next/scripts/replace.js index 654eb6a4f97b0..bf7cd5aca3ca0 100644 --- a/site2/website-next/scripts/replace.js +++ b/site2/website-next/scripts/replace.js @@ -192,9 +192,9 @@ doReplace(options); // TODO activate and test when first version of docs are cut // replaces versions for (v of versions) { - if (v === latestVersion) { - continue; - } + // if (v === latestVersion) { + // continue; + // } const vWithoutIncubating = v.replace("-incubating", ""); const opts = { files: [ From 44749c49846744231e38e4cc743739a6aca8fe2b Mon Sep 17 00:00:00 2001 From: LiLi Date: Tue, 12 Oct 2021 19:52:23 +0800 Subject: [PATCH 5/5] feat: exec replace script before build command Signed-off-by: LiLi --- site2/website-next/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site2/website-next/package.json b/site2/website-next/package.json index 52ad62fe0617f..833240c621999 100644 --- a/site2/website-next/package.json +++ b/site2/website-next/package.json @@ -5,7 +5,7 @@ "scripts": { "docusaurus": "docusaurus", "start": "docusaurus start", - "build": "docusaurus build", + "build": "node scripts/replace.js && docusaurus build", "swizzle": "docusaurus swizzle", "deploy": "docusaurus deploy", "clear": "docusaurus clear",