From e4ff5dde681624d7168cf6ca2c8a579ce8ab994b Mon Sep 17 00:00:00 2001 From: YuCheng Hu Date: Wed, 30 Sep 2020 14:27:40 -0400 Subject: [PATCH] init submit the docsify folder --- .nojekyll | 0 .travis.yml | 40 ---------- README.adoc | 30 -------- build.gradle | 96 ------------------------ cwikius-docs.iml | 9 +++ gradlew | 188 ----------------------------------------------- gradlew.bat | 100 ------------------------- index.html | 21 ++++++ settings.gradle | 1 - 9 files changed, 30 insertions(+), 455 deletions(-) create mode 100644 .nojekyll delete mode 100644 .travis.yml delete mode 100644 README.adoc delete mode 100644 build.gradle create mode 100644 cwikius-docs.iml delete mode 100644 gradlew delete mode 100644 gradlew.bat create mode 100644 index.html delete mode 100644 settings.gradle diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 52dbde4..0000000 --- a/.travis.yml +++ /dev/null @@ -1,40 +0,0 @@ -language: java -install: true - -jdk: - - openjdk8 - -os: - - linux - -branches: - only: - - master - -cache: - directories: - - $HOME/.gradle - -before_install: - - chmod +x gradlew - - -before_script: - - git fetch - - git checkout -b gh-pages - - git merge origin/master - - git rm --cached --ignore-unmatch index.html - -script: - - ./gradlew asciidoctor - - -deploy: - provider: s3 - access_key_id: "$AWS_ACCESS_KEY" - secret_access_key: "$AWS_SECRET_KEY" - region: us-east-2 - bucket: "com.ossez.docs" - skip_cleanup: true - local_dir: build/asciidoc/html5 - upload-dir: protocol-buffers-docs diff --git a/README.adoc b/README.adoc deleted file mode 100644 index 16a8c8b..0000000 --- a/README.adoc +++ /dev/null @@ -1,30 +0,0 @@ -= Protocol Buffers 文档 -YuCheng Hu -:doctype: book -:page-layout: docs -:page-description: Protocol Buffers -:page-keywords: Protocol Buffers - -Protocol Buffers 相关文档的内容，本文档是针对官方的文档进行翻译和编辑的。 - -image::https://travis-ci.org/cwiki-us-docs/protocol-buffers-docs.svg?branch=master[] - -image::http://docs.ossez.com/protocol-buffers-docs/images/protocol-buffers-logo.jpg[] - -== 文档和资料 -针对 Protocol Buffers 相关的文档和资料的快速链接。 - -=== WIKI 和已编译的文档 - * https://www.cwiki.us/display/ProtocolBuffers/Protocol+Buffers - cwiki.us 的 Protocol Buffer WIKI - * http://docs.ossez.com/protocol-buffers-docs/index.html - Protocol Buffer 技术资料 - -=== SCM (Source Control Management) 源代码 - * https://github.com/cwiki-us-docs/protocol-buffers-docs - Protocol Buffers 文档的源代码 - * https://github.com/cwiki-us-demo/protocol-buffers-demo-java - Protocol Buffers 示例程序 - - -== Protocol Buffers 简介 -我们是在实际的数据处理的时候，需要使用 JSON 来序列化数据，但是又考虑到 JSON 在传输的时候数据过大，同时还有很多并不需要的垃圾文件。 -我们才考虑到了 Protocol Buffer 提供的功能。 - -image::http://docs.ossez.com/protocol-buffers-docs/images/protocol-buffers-serialization.png[] diff --git a/build.gradle b/build.gradle deleted file mode 100644 index a96c1f7..0000000 --- a/build.gradle +++ /dev/null @@ -1,96 +0,0 @@ -plugins { - id "org.asciidoctor.convert" version "2.3.0" -} - -apply plugin: 'java' - -version = '1.0.0' - -allprojects { - repositories { - maven { url "https://maven.ossez.com/repository/internal" } - } - - ext { - environmentProperty = project.hasProperty('environment') ? getProperty('environment') : 'hsql' - - docResourcesVersion = '0.1.0' - } - - apply plugin: 'idea' -} - -allprojects { - repositories { - maven { url "https://maven.ossez.com/repository/internal" } - } -} -configurations { - docs -} - -dependencies { - docs "com.ossez.docresources:ossez-doc-resources:${docResourcesVersion}@zip" -} - - -task prepareAsciidocBuildZH(type: Sync) { - dependsOn configurations.docs - // copy doc resources - from { - configurations.docs.collect { zipTree(it) } - } - // and doc sources - from "src/docs/asciidoc/" - // to a build directory of your choice - into "$buildDir/asciidoc/assemble" - -} - -task('makePDFZH', type: org.asciidoctor.gradle.AsciidoctorTask){ - dependsOn prepareAsciidocBuildZH - backends 'pdf' - sourceDir "$buildDir/asciidoc/assemble" - sources { - include 'index-single.adoc' - } - options doctype: 'book', eruby: 'erubis' - logDocuments = true - attributes 'icons': 'font', - 'sectanchors': '', - 'sectnums': '', - 'toc': '', - 'source-highlighter' : 'coderay', - revnumber: project.version -} - -asciidoctor { - dependsOn makePDFZH - backends 'html5' - sourceDir "$buildDir/asciidoc/assemble" - resources { - from(sourceDir) { - include 'images/*', 'css/**', 'js/**' - } - } - options doctype: 'book', eruby: 'erubis' - logDocuments = true - attributes 'docinfo': 'shared', - // use provided stylesheet - stylesdir: "css/", - stylesheet: 'ossez.css', - 'linkcss': true, - 'icons': 'font', - 'sectanchors': '', - // use provided highlighter - 'source-highlighter=highlight.js', - 'highlightjsdir=js/highlight', - 'highlightjs-theme=atom-one-dark-reasonable', - 'idprefix': '', - 'idseparator': '-', - 'spring-version': project.version, - 'allow-uri-read': '', - revnumber: project.version -} - - diff --git a/cwikius-docs.iml b/cwikius-docs.iml new file mode 100644 index 0000000..ad3c0a3 --- /dev/null +++ b/cwikius-docs.iml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/gradlew b/gradlew deleted file mode 100644 index b0d6d0a..0000000 --- a/gradlew +++ /dev/null @@ -1,188 +0,0 @@ -#!/usr/bin/env sh - -# -# Copyright 2015 the original author or authors. -# -# 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. -# - -############################################################################## -## -## Gradle start up script for UN*X -## -############################################################################## - -# Attempt to set APP_HOME -# Resolve links: $0 may be a link -PRG="$0" -# Need this for relative symlinks. -while [ -h "$PRG" ] ; do - ls=`ls -ld "$PRG"` - link=`expr "$ls" : '.*-> \(.*\)$'` - if expr "$link" : '/.*' > /dev/null; then - PRG="$link" - else - PRG=`dirname "$PRG"`"/$link" - fi -done -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >/dev/null -APP_HOME="`pwd -P`" -cd "$SAVED" >/dev/null - -APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` - -# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' - -# Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD="maximum" - -warn () { - echo "$*" -} - -die () { - echo - echo "$*" - echo - exit 1 -} - -# OS specific support (must be 'true' or 'false'). -cygwin=false -msys=false -darwin=false -nonstop=false -case "`uname`" in - CYGWIN* ) - cygwin=true - ;; - Darwin* ) - darwin=true - ;; - MINGW* ) - msys=true - ;; - NONSTOP* ) - nonstop=true - ;; -esac - -CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar - -# Determine the Java command to use to start the JVM. -if [ -n "$JAVA_HOME" ] ; then - if [ -x "$JAVA_HOME/jre/sh/java" ] ; then - # IBM's JDK on AIX uses strange locations for the executables - JAVACMD="$JAVA_HOME/jre/sh/java" - else - JAVACMD="$JAVA_HOME/bin/java" - fi - if [ ! -x "$JAVACMD" ] ; then - die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME - -Please set the JAVA_HOME variable in your environment to match the -location of your Java installation." - fi -else - JAVACMD="java" - which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. - -Please set the JAVA_HOME variable in your environment to match the -location of your Java installation." -fi - -# Increase the maximum file descriptors if we can. -if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then - MAX_FD_LIMIT=`ulimit -H -n` - if [ $? -eq 0 ] ; then - if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then - MAX_FD="$MAX_FD_LIMIT" - fi - ulimit -n $MAX_FD - if [ $? -ne 0 ] ; then - warn "Could not set maximum file descriptor limit: $MAX_FD" - fi - else - warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" - fi -fi - -# For Darwin, add options to specify how the application appears in the dock -if $darwin; then - GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" -fi - -# For Cygwin, switch paths to Windows format before running java -if $cygwin ; then - APP_HOME=`cygpath --path --mixed "$APP_HOME"` - CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` - JAVACMD=`cygpath --unix "$JAVACMD"` - - # We build the pattern for arguments to be converted via cygpath - ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` - SEP="" - for dir in $ROOTDIRSRAW ; do - ROOTDIRS="$ROOTDIRS$SEP$dir" - SEP="|" - done - OURCYGPATTERN="(^($ROOTDIRS))" - # Add a user-defined pattern to the cygpath arguments - if [ "$GRADLE_CYGPATTERN" != "" ] ; then - OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" - fi - # Now convert the arguments - kludge to limit ourselves to /bin/sh - i=0 - for arg in "$@" ; do - CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` - CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option - - if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition - eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` - else - eval `echo args$i`="\"$arg\"" - fi - i=$((i+1)) - done - case $i in - (0) set -- ;; - (1) set -- "$args0" ;; - (2) set -- "$args0" "$args1" ;; - (3) set -- "$args0" "$args1" "$args2" ;; - (4) set -- "$args0" "$args1" "$args2" "$args3" ;; - (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; - esac -fi - -# Escape application args -save () { - for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done - echo " " -} -APP_ARGS=$(save "$@") - -# Collect all arguments for the java command, following the shell quoting and substitution rules -eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" - -# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong -if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then - cd "$(dirname "$0")" -fi - -exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat deleted file mode 100644 index 9991c50..0000000 --- a/gradlew.bat +++ /dev/null @@ -1,100 +0,0 @@ -@rem -@rem Copyright 2015 the original author or authors. -@rem -@rem Licensed under the Apache License, Version 2.0 (the "License"); -@rem you may not use this file except in compliance with the License. -@rem You may obtain a copy of the License at -@rem -@rem http://www.apache.org/licenses/LICENSE-2.0 -@rem -@rem Unless required by applicable law or agreed to in writing, software -@rem distributed under the License is distributed on an "AS IS" BASIS, -@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -@rem See the License for the specific language governing permissions and -@rem limitations under the License. -@rem - -@if "%DEBUG%" == "" @echo off -@rem ########################################################################## -@rem -@rem Gradle startup script for Windows -@rem -@rem ########################################################################## - -@rem Set local scope for the variables with windows NT shell -if "%OS%"=="Windows_NT" setlocal - -set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. -set APP_BASE_NAME=%~n0 -set APP_HOME=%DIRNAME% - -@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" - -@rem Find java.exe -if defined JAVA_HOME goto findJavaFromJavaHome - -set JAVA_EXE=java.exe -%JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto init - -echo. -echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:findJavaFromJavaHome -set JAVA_HOME=%JAVA_HOME:"=% -set JAVA_EXE=%JAVA_HOME%/bin/java.exe - -if exist "%JAVA_EXE%" goto init - -echo. -echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:init -@rem Get command-line arguments, handling Windows variants - -if not "%OS%" == "Windows_NT" goto win9xME_args - -:win9xME_args -@rem Slurp the command line arguments. -set CMD_LINE_ARGS= -set _SKIP=2 - -:win9xME_args_slurp -if "x%~1" == "x" goto execute - -set CMD_LINE_ARGS=%* - -:execute -@rem Setup the command line - -set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar - -@rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% - -:end -@rem End local scope for the variables with windows NT shell -if "%ERRORLEVEL%"=="0" goto mainEnd - -:fail -rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of -rem the _cmd.exe /c_ return code! -if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 -exit /b 1 - -:mainEnd -if "%OS%"=="Windows_NT" endlocal - -:omega diff --git a/index.html b/index.html new file mode 100644 index 0000000..a66b6b1 --- /dev/null +++ b/index.html @@ -0,0 +1,21 @@ + + + + + Document + + + + + + +
+ + + + diff --git a/settings.gradle b/settings.gradle deleted file mode 100644 index 8cf4caa..0000000 --- a/settings.gradle +++ /dev/null @@ -1 +0,0 @@ -rootProject.name = 'protocol-buffers-docs'