minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00
Code Activity

cleanup SDK sync and reduce makefile burden (#585)

Browse Source
This commit is contained in:
Harshavardhana
2022-09-26 13:52:15 -07:00
committed by GitHub
parent 92ee087d4f
commit aaa74a8ee7
3 changed files with 70 additions and 173 deletions
Download Patch File Download Diff File Expand all files Collapse all files

172
Makefile
View File

@ -44,8 +44,6 @@ linux:
@make sync-minio-version @make sync-minio-version
@make sync-kes-version @make sync-kes-version
ifeq ($(SYNC_SDK),TRUE) ifeq ($(SYNC_SDK),TRUE)
@echo "Synchronizing SDK content. Performing this operation too frequently may result in Github limiting API access"
@echo "Omit SYNC_SDK=TRUE to prevent SDK synchronization"
@make sync-sdks @make sync-sdks
else else
@echo "Not synchronizing SDKs, pass SYNC_SDK=TRUE to synchronize SDK content" @echo "Not synchronizing SDKs, pass SYNC_SDK=TRUE to synchronize SDK content"
@ -140,183 +138,15 @@ sync-minio-version:
;; \ ;; \
esac esac
sync-cpp-docs:
# C++ repo does not have any releases yet.
@echo "Retrieving C++ docs from github.com/minio/minio-js"
@$(eval CPPLATEST = $(shell curl --retry 10 -Ls -o /dev/null -w "%{url_effective}" https://github.com/minio/minio-cpp/releases/latest | sed "s/https:\/\/github.com\/minio\/minio-cpp\/releases\/tag\///"))
@echo "Latest stable is ${CPPLATEST}"
$(shell wget -q -O source/developers/cpp/API.md https://raw.githubusercontent.com/minio/minio-cpp/${CPPLATEST}/docs/API.md)
$(shell wget -q -O source/developers/cpp/quickstart.md https://raw.githubusercontent.com/minio/minio-cpp/${CPPLATEST}/README.md)
@$(eval kname = $(shell uname -s))
@case "${kname}" in \
"Darwin") \
sed -i "" "s|CPPVERSION|${CPPLATEST}|g" source/conf.py;\
;; \
*) \
sed -i "s|CPPVERSION|${CPPLATEST}|g" source/conf.py; \
;; \
esac
sync-dotnet-docs:
@echo "Retrieving .NET docs from github.com/minio/minio-dotnet"
@$(eval DOTNETLATEST = $(shell curl --retry 10 -Ls -o /dev/null -w "%{url_effective}" https://github.com/minio/minio-dotnet/releases/latest | sed "s/https:\/\/github.com\/minio\/minio-dotnet\/releases\/tag\///"))
@echo "Latest stable is ${DOTNETLATEST}"
$(shell wget -q -O source/developers/dotnet/API.md https://raw.githubusercontent.com/minio/minio-dotnet/${DOTNETLATEST}/Docs/API.md)
$(shell wget -q -O source/developers/dotnet/quickstart.md https://raw.githubusercontent.com/minio/minio-dotnet/${DOTNETLATEST}/README.md)
@$(eval kname = $(shell uname -s))
@case "${kname}" in \
"Darwin") \
sed -i "" "s|DOTNETVERSION|${DOTNETLATEST}|g" source/conf.py;\
;; \
*) \
sed -i "s|DOTNETVERSION|${DOTNETLATEST}|g" source/conf.py; \
;; \
esac
sync-go-docs:
@echo "Retrieving Go docs from github.com/minio/minio-go"
@$(eval GOLATEST = $(shell curl --retry 10 -Ls -o /dev/null -w "%{url_effective}" https://github.com/minio/minio-go/releases/latest | sed "s/https:\/\/github.com\/minio\/minio-go\/releases\/tag\///"))
@echo "Latest stable is ${GOLATEST}"
$(shell wget -q -O source/developers/go/API.md https://raw.githubusercontent.com/minio/minio-go/${GOLATEST}/docs/API.md)
$(shell wget -q -O source/developers/go/quickstart.md https://raw.githubusercontent.com/minio/minio-go/${GOLATEST}/README.md)
@$(eval kname = $(shell uname -s))
@case "${kname}" in \
"Darwin") \
sed -i "" "s|GOVERSION|${GOLATEST}|g" source/conf.py;\
;; \
*) \
sed -i "s|GOVERSION|${GOLATEST}|g" source/conf.py; \
;; \
esac
sync-haskell-docs:
@echo "Retrieving Haskell docs from github.com/minio/minio-hs"
@$(eval HASKELLLATEST = $(shell curl --retry 10 -Ls -o /dev/null -w "%{url_effective}" https://github.com/minio/minio-hs/releases/latest | sed "s/https:\/\/github.com\/minio\/minio-hs\/releases\/tag\///"))
@echo "Latest stable is ${HASKELLLATEST}"
$(shell wget -q -O source/developers/haskell/API.md https://raw.githubusercontent.com/minio/minio-hs/${HASKELLLATEST}/docs/API.md)
$(shell wget -q -O source/developers/haskell/quickstart.md https://raw.githubusercontent.com/minio/minio-hs/${HASKELLLATEST}/README.md)
@$(eval kname = $(shell uname -s))
@case "${kname}" in \
"Darwin") \
sed -i "" "s|HASKELLVERSION|${HASKELLLATEST}|g" source/conf.py;\
;; \
*) \
sed -i "s|HASKELLVERSION|${HASKELLLATEST}|g" source/conf.py; \
;; \
esac
sync-java-docs:
@echo "Retrieving Java docs from github.com/minio/minio-java"
@$(eval JAVALATEST = $(shell curl --retry 10 -Ls -o /dev/null -w "%{url_effective}" https://github.com/minio/minio-java/releases/latest | sed "s/https:\/\/github.com\/minio\/minio-java\/releases\/tag\///"))
@echo "Latest stable is ${JAVALATEST}"
$(shell wget -q -O source/developers/java/API.md https://raw.githubusercontent.com/minio/minio-java/${JAVALATEST}/docs/API.md)
$(shell wget -q -O source/developers/java/quickstart.md https://raw.githubusercontent.com/minio/minio-java/${JAVALATEST}/README.md)
@$(eval JAVAJARURL = https://repo1.maven.org/maven2/io/minio/minio/${JAVALATEST}/)
@$(eval kname = $(shell uname -s))
@case "${kname}" in \
"Darwin") \
sed -i "" "s|JAVAVERSION|${JAVALATEST}|g" source/conf.py;\
sed -i "" "s|JAVAURL|${JAVAJARURL}|g" source/conf.py;\
;; \
*) \
sed -i "s|JAVAVERSION|${JAVALATEST}|g" source/conf.py; \
sed -i "s|JAVAURL|${JAVAJARURL}|g" source/conf.py;\
;; \
esac
sync-javascript-docs:
@echo "Retrieving JavaScript docs from github.com/minio/minio-js"
@$(eval JAVASCRIPTLATEST = $(shell curl --retry 10 -Ls -o /dev/null -w "%{url_effective}" https://github.com/minio/minio-js/releases/latest | sed "s/https:\/\/github.com\/minio\/minio-js\/releases\/tag\///"))
@echo "Latest stable is ${JAVASCRIPTLATEST}"
$(shell wget -q -O source/developers/javascript/API.md https://raw.githubusercontent.com/minio/minio-js/${JAVASCRIPTLATEST}/docs/API.md)
$(shell wget -q -O source/developers/javascript/quickstart.md https://raw.githubusercontent.com/minio/minio-js/${JAVASCRIPTLATEST}/README.md)
@$(eval kname = $(shell uname -s))
@case "${kname}" in \
"Darwin") \
sed -i "" "s|JAVASCRIPTVERSION|${JAVASCRIPTLATEST}|g" source/conf.py;\
;; \
*) \
sed -i "s|JAVASCRIPTVERSION|${JAVASCRIPTLATEST}|g" source/conf.py; \
;; \
esac
sync-python-docs:
@echo "Retrieving Python docs from github.com/minio/minio-py"
@$(eval PYTHONLATEST = $(shell curl --retry 10 -Ls -o /dev/null -w "%{url_effective}" https://github.com/minio/minio-py/releases/latest | sed "s/https:\/\/github.com\/minio\/minio-py\/releases\/tag\///"))
@echo "Latest stable is ${PYTHONLATEST}"
$(shell wget -q -O source/developers/python/API.md https://raw.githubusercontent.com/minio/minio-py/${PYTHONLATEST}/docs/API.md)
$(shell wget -q -O source/developers/python/quickstart.md https://raw.githubusercontent.com/minio/minio-py/${PYTHONLATEST}/README.md)
@$(eval kname = $(shell uname -s))
@case "${kname}" in \
"Darwin") \
sed -i "" "s|PYTHONVERSION|${PYTHONLATEST}|g" source/conf.py;\
;; \
*) \
sed -i "s|PYTHONVERSION|${PYTHONLATEST}|g" source/conf.py; \
;; \
esac
sync-rust-docs:
# Rust repo does not have any releases yet.
@echo "Retrieving Rust docs from github.com/minio/minio-js"
@$(eval RUSTLATEST = $(shell curl --retry 10 -Ls -o /dev/null -w "%{url_effective}" https://github.com/minio/minio-rust/releases/latest | sed "s/https:\/\/github.com\/minio\/minio-rust\/releases\/tag\///"))
@echo "Latest stable is ${RUSTLATEST}"
# $(shell wget -q -O source/developers/rust/API.md https://raw.githubusercontent.com/minio/minio-rs/${RUSTLATEST}/docs/API.md)
$(shell wget -q -O source/developers/rust/quickstart.md https://raw.githubusercontent.com/minio/minio-rs/${RUSTLATEST}/README.md)
@$(eval kname = $(shell uname -s))
@case "${kname}" in \
"Darwin") \
sed -i "" "s|RUSTVERSION|${RUSTLATEST}|g" source/conf.py;\
;; \
*) \
sed -i "s|RUSTVERSION|${RUSTLATEST}|g" source/conf.py; \
;; \
esac
# This results in a lot of API operations to GitHub. You might hit request limits if you aren't careful.
sync-sdks: sync-sdks:
# C++ and Rust repos do not have any releases yet. @(./sync-docs.sh)
# @make sync-cpp-docs
@make sync-dotnet-docs
@make sync-go-docs
@make sync-haskell-docs
@make sync-java-docs
@make sync-javascript-docs
@make sync-python-docs
# @make sync-rust-docs
# Can probably safely remove this at some point # Can probably safely remove this at some point
sync-deps: sync-deps:
# C++ and Rust repos do not have any releases yet. # C++ and Rust repos do not have any releases yet.
@echo "Synchronizing all external dependencies" @echo "Synchronizing all external dependencies"
@make sync-minio-version @make sync-minio-version
@make sync-kes-version @make sync-kes-version
# @make sync-cpp-docs
@make sync-dotnet-docs
@make sync-go-docs
@make sync-haskell-docs
@make sync-java-docs
@make sync-javascript-docs
@make sync-python-docs
# @make sync-rust-docs
# Catch-all target: route all unknown targets to Sphinx using the new # Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).

3
build-docs.sh
View File

@ -10,9 +10,8 @@ nvm use stable
export PATH=${PATH}:${HOME}/.local/bin export PATH=${PATH}:${HOME}/.local/bin
make clean make clean
make SYNC_SDK=TRUE linux SYNC_SDK=TRUE make linux
make windows macos container k8s make windows macos container k8s
#make linux windows macos container k8s
sudo rm -rf /var/www/docs/minio/kubernetes/upstream sudo rm -rf /var/www/docs/minio/kubernetes/upstream
sudo mkdir -p /var/www/docs/minio/kubernetes/upstream sudo mkdir -p /var/www/docs/minio/kubernetes/upstream

68
sync-docs.sh Executable file
View File

@ -0,0 +1,68 @@
#!/bin/bash
set -e
set -x
function replace() {
tmp_prefix=${RANDOM}
old_IFS=$IFS
IFS=$'\n'
while read -r line
do
echo "${line/"${1}"/""${2}""}"
done < source/conf.py > source/conf.py.${tmp_prefix}
IFS=$old_IFS
mv -f source/conf.py.${tmp_prefix} source/conf.py
}
function main() {
if [ "$#" -eq 0 ]; then
SDKS="dotnet go java js py hs"
fi
for sdk in ${SDKS}; do
sdk_version=$(curl --retry 10 -Ls -o /dev/null -w "%{url_effective}" https://github.com/minio/minio-${sdk}/releases/latest | sed "s,https://github.com/minio/minio-${sdk}/releases/tag/,,g")
echo "latest stable ${sdk} for ${sdk_version}"
sdk_dir="docs"
if [ "${sdk}" == "dotnet" ]; then
sdk_dir="Docs"
fi
source_dir=${sdk}
case ${sdk} in
"js")
source_dir="javascript"
;;
"py")
source_dir="python"
;;
"hs")
source_dir="haskell"
;;
esac
curl --retry 10 -Ls -o source/developers/${source_dir}/API.md https://raw.githubusercontent.com/minio/minio-${sdk}/${sdk_version}/${sdk_dir}/API.md
curl --retry 10 -Ls -o source/developers/${source_dir}/quickstart.md https://raw.githubusercontent.com/minio/minio-${sdk}/${sdk_version}/README.md
case ${sdk} in
"dotnet")
replace DOTNETVERSION ${sdk_version}
;;
"go")
replace GOVERSION ${sdk_version}
;;
"java")
replace JAVAVERSION ${sdk_version}
;;
"js")
replace JAVASCRIPTVERSION ${sdk_version}
;;
"py")
replace PYTHONVERSION ${sdk_version}
;;
"hs")
replace HASKELLVERSION ${sdk_version}
;;
esac
done
}
main "$@"