forked from alibaba/GraphScope
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(interactive): Fix interactive doc and image building (alibaba#3767)
- Loading branch information
1 parent
5307437
commit 8b8b4bb
Showing
8 changed files
with
111 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # GraphScope Interactive Deployment | ||
| # Deployment | ||
|
|
||
| ## Deploy with docker | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| #!/bin/bash | ||
| # Copyright 2020 Alibaba Group Holding Limited. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| # This script is used to generate the Java SDK from the Flex Interactive API | ||
| # It uses the Swagger Codegen tool to generate the SDK | ||
|
|
||
|
|
||
| GENERATED_ENDPOINT="https://virtserver.swaggerhub.com/GRAPHSCOPE/InteractiveAPI/1.0.0" | ||
| ENDPOINT_PLACE_HOLDER="{INTERACTIVE_ENDPOINT}" | ||
|
|
||
| function usage() { | ||
| echo "Usage: $0 [options]" | ||
| echo "Options:" | ||
| echo " -h, --help Show this help message and exit" | ||
| echo " -o, --output-dir Generate the SDK for the specified language" | ||
| } | ||
|
|
||
| function do_gen() { | ||
| echo "Generating SDK documentation" | ||
| OUTPUT_PATH="$1" | ||
| echo "Output path: ${OUTPUT_PATH}" | ||
| # First check whether java/docs and python/docs exist | ||
| if [ ! -d "./java/docs" ]; then | ||
| echo "java/docs not found, please generate the SDK first" | ||
| exit 1 | ||
| fi | ||
| if [ ! -d "./python/docs" ]; then | ||
| echo "python/docs not found, please generate the SDK first" | ||
| exit 1 | ||
| fi | ||
| # post process the generated docs inplace. | ||
| # replace all occurrence of $GENERATED_ENDPOINT with $ENDPOINT_PLACE_HOLDER | ||
| # in the generated docs, for all files under ./java/docs and ./python/docs | ||
| cmd="sed -i 's|${GENERATED_ENDPOINT}|${ENDPOINT_PLACE_HOLDER}|g' ./java/docs/*" | ||
| echo "Running command: ${cmd}" | ||
| eval $cmd | ||
| cmd="sed -i 's|${GENERATED_ENDPOINT}|${ENDPOINT_PLACE_HOLDER}|g' ./python/docs/*" | ||
| echo "Running command: ${cmd}" | ||
| eval $cmd | ||
|
|
||
| # Copy the generated docs to the output path | ||
| cmd="cp -r ./java/docs/* ${OUTPUT_PATH}/java/" | ||
| echo "Running command: ${cmd}" | ||
| eval $cmd | ||
| cmd="cp -r ./python/docs/* ${OUTPUT_PATH}/python/" | ||
| echo "Running command: ${cmd}" | ||
| eval $cmd | ||
|
|
||
| echo "SDK documentation generated successfully." | ||
| } | ||
|
|
||
|
|
||
| while [[ $# -gt 0 ]]; do | ||
| key="$1" | ||
|
|
||
| case $key in | ||
| -h | --help) | ||
| usage | ||
| exit | ||
| ;; | ||
| -o | --output-dir) | ||
| shift | ||
| do_gen "$@" | ||
| exit 0 | ||
| ;; | ||
| *) # unknown option | ||
| err "unknown option $1" | ||
| usage | ||
| exit 1 | ||
| ;; | ||
| esac | ||
| done |