Permalink
Browse files

[feat][docs][website] Initial docusaurus based site (#1770)

* Iniital docusaurus based site

* Remove error about default local being used by String.format

* Change pinned users to represent global presence rather than alphabetical order pinning

* Include generator indexes in ensure-up-to-date (docusaurus site and /generators/README)

* Add Font Awesome attribution footer

* Remove feature callout until it is completed

* Include NPM try it out section

* Improve "Getting Started" type docs

* Include new custom template documentation

* Updating templating and customization docs

* Add vendor extension docs

* Cleanup templating page(s).

* Move users to yaml file for easy edit.

* travis configuration, and baseUrl mods to image URLs

* [docs] Migrate FAQ, release summary  from wiki

FAQ has been split into multiple smaller documents to better categorize
and allow users to find what they're looking for (in docs folder or in
new website).

Release summary information (versioning strategy and cadence) has been
migrated from the Wiki and clarified a bit.

Also adds copy button for all code snippets in website.

* Copy current contributing/code of conduct to website

* [docs] Creating a new generator
  • Loading branch information...
jimschubert authored and wing328 committed Jan 18, 2019
1 parent 9cba9b6 commit 6fe9a52229935b68c142d85e4c0e6cd0eabbebfe
Showing with 13,543 additions and 5,334 deletions.
  1. +11 −1 .travis.yml
  2. +1 −1 README.md
  3. +34 −0 bin/utils/copy-to-website.sh
  4. +3 −0 bin/utils/ensure-up-to-date
  5. +1 −3 bin/utils/export_generator.sh
  6. +20 −0 bin/utils/export_generators_docusaurus_index.sh
  7. +13 −1 bin/utils/export_generators_readme.sh
  8. +18 −0 docker-compose.yml
  9. +362 −361 docs/3.0.0-release-note.md
  10. +76 −0 docs/building.md
  11. +49 −0 docs/conduct.md
  12. +107 −0 docs/contributing.md
  13. +12 −0 docs/core-team.md
  14. +11 −28 docs/customization.md
  15. +64 −0 docs/debugging.md
  16. +66 −0 docs/faq-contributing.md
  17. +40 −0 docs/faq-extending.md
  18. +115 −0 docs/faq-generators.md
  19. +18 −0 docs/faq.md
  20. +126 −0 docs/generators.md
  21. +7 −2 docs/generators/README.md
  22. +13 −18 docs/generators/ada-server.md
  23. +13 −18 docs/generators/ada.md
  24. +25 −56 docs/generators/android.md
  25. +13 −18 docs/generators/apache2.md
  26. +16 −27 docs/generators/apex.md
  27. +18 −33 docs/generators/aspnetcore.md
  28. +20 −39 docs/generators/bash.md
  29. +13 −18 docs/generators/c.md
  30. +19 −36 docs/generators/clojure.md
  31. +10 −9 docs/generators/cpp-pistache-server.md
  32. +15 −24 docs/generators/cpp-qt5-client.md
  33. +14 −21 docs/generators/cpp-qt5-qhttpengine-server.md
  34. +0 −22 docs/generators/cpp-qt5.md
  35. +13 −18 docs/generators/cpp-restbed-server.md
  36. +14 −21 docs/generators/cpp-restsdk.md
  37. +12 −15 docs/generators/cpp-tizen.md
  38. +11 −12 docs/generators/csharp-dotnet2.md
  39. +22 −45 docs/generators/csharp-nancyfx.md
  40. +30 −0 docs/generators/csharp-refactor.md
  41. +30 −74 docs/generators/csharp.md
  42. +22 −45 docs/generators/cwiki.md
  43. +20 −39 docs/generators/dart-jaguar.md
  44. +19 −36 docs/generators/dart.md
  45. +16 −27 docs/generators/dynamic-html.md
  46. +11 −12 docs/generators/eiffel.md
  47. +15 −24 docs/generators/elixir.md
  48. +12 −17 docs/generators/elm.md
  49. +10 −9 docs/generators/erlang-client.md
  50. +10 −9 docs/generators/erlang-proper.md
  51. +10 −9 docs/generators/erlang-server.md
  52. +12 −15 docs/generators/flash.md
  53. +10 −9 docs/generators/go-gin-server.md
  54. +10 −9 docs/generators/go-server.md
  55. +14 −21 docs/generators/go.md
  56. +11 −12 docs/generators/graphql-schema.md
  57. +11 −12 docs/generators/graphql-server.md
  58. +44 −118 docs/generators/groovy.md
  59. +31 −72 docs/generators/haskell-http-client.md
  60. +14 −21 docs/generators/haskell.md
  61. +22 −45 docs/generators/html.md
  62. +26 −57 docs/generators/html2.md
  63. +43 −115 docs/generators/java-inflector.md
  64. +48 −132 docs/generators/java-msf4j.md
  65. +53 −145 docs/generators/java-pkmst.md
  66. +52 −142 docs/generators/java-play-framework.md
  67. +43 −115 docs/generators/java-undertow-server.md
  68. +45 −121 docs/generators/java-vertx.md
  69. +56 −166 docs/generators/java.md
  70. +14 −21 docs/generators/javascript-closure-angular.md
  71. +18 −33 docs/generators/javascript-flowtyped.md
  72. +29 −66 docs/generators/javascript.md
  73. +53 −146 docs/generators/jaxrs-cxf-cdi.md
  74. +47 −127 docs/generators/jaxrs-cxf-client.md
  75. +64 −178 docs/generators/jaxrs-cxf.md
  76. +50 −138 docs/generators/jaxrs-jersey.md
  77. +50 −136 docs/generators/jaxrs-resteasy-eap.md
  78. +48 −130 docs/generators/jaxrs-resteasy.md
  79. +52 −143 docs/generators/jaxrs-spec.md
  80. +12 −15 docs/generators/jmeter.md
  81. +21 −43 docs/generators/kotlin-server.md
  82. +27 −61 docs/generators/kotlin-spring.md
  83. +17 −35 docs/generators/kotlin.md
  84. +11 −12 docs/generators/lua.md
  85. +10 −9 docs/generators/mysql-schema.md
  86. +15 −24 docs/generators/nodejs-server.md
  87. +16 −27 docs/generators/objc.md
  88. +13 −18 docs/generators/openapi-yaml.md
  89. +12 −15 docs/generators/openapi.md
  90. +14 −21 docs/generators/perl.md
  91. +21 −42 docs/generators/php-laravel.md
  92. +21 −42 docs/generators/php-lumen.md
  93. +12 −15 docs/generators/php-silex.md
  94. +21 −42 docs/generators/php-slim.md
  95. +26 −57 docs/generators/php-symfony.md
  96. +21 −42 docs/generators/php-ze-ph.md
  97. +24 −51 docs/generators/php.md
  98. +11 −12 docs/generators/powershell.md
  99. +18 −33 docs/generators/python-flask.md
  100. +16 −27 docs/generators/python.md
  101. +11 −12 docs/generators/r.md
  102. +8 −5 docs/generators/ruby-on-rails.md
  103. +7 −2 docs/generators/ruby-sinatra.md
  104. +23 −48 docs/generators/ruby.md
  105. +10 −9 docs/generators/rust-server.md
  106. +12 −17 docs/generators/rust.md
  107. +16 −27 docs/generators/scala-akka.md
  108. +11 −12 docs/generators/scala-finch.md
  109. +15 −24 docs/generators/scala-gatling.md
  110. +16 −27 docs/generators/scala-httpclient.md
  111. +16 −27 docs/generators/scala-lagom-server.md
  112. +15 −24 docs/generators/scalatra.md
  113. +16 −27 docs/generators/scalaz.md
  114. +64 −181 docs/generators/spring.md
  115. +28 −63 docs/generators/swift2-deprecated.md
  116. +31 −0 docs/generators/swift3-deprecated.md
  117. +0 −70 docs/generators/swift3.md
  118. +30 −69 docs/generators/swift4.md
  119. +27 −60 docs/generators/typescript-angular.md
  120. +14 −21 docs/generators/typescript-angularjs.md
  121. +16 −27 docs/generators/typescript-aurelia.md
  122. +19 −36 docs/generators/typescript-axios.md
  123. +19 −36 docs/generators/typescript-fetch.md
  124. +21 −42 docs/generators/typescript-inversify.md
  125. +19 −36 docs/generators/typescript-jquery.md
  126. +18 −33 docs/generators/typescript-node.md
  127. +148 −0 docs/installation.md
  128. +6 −4 docs/integration.md
  129. +17 −27 docs/migration-from-swagger-codegen.md
  130. +403 −0 docs/new-generator.md
  131. +0 −88 docs/online-openapi-generator.md
  132. +144 −0 docs/online.md
  133. +99 −0 docs/plugins.md
  134. +15 −29 docs/qna.md
  135. +24 −0 docs/release-summary.md
  136. +85 −0 docs/roadmap.md
  137. +17 −0 docs/specification-info.md
  138. +743 −0 docs/templating.md
  139. +502 −0 docs/usage.md
  140. +76 −6 modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ConfigHelp.java
  141. +23 −4 modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ListGenerators.java
  142. +1 −0 modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenType.java
  143. +16 −5 new.sh
  144. +106 −0 website/README.md
  145. +13 −0 website/blog/2018-12-24-new-website.md
  146. +40 −0 website/core/EditThisPage.js
  147. +115 −0 website/core/Footer.js
  148. +23 −0 website/dynamic/team.yml
  149. +95 −0 website/dynamic/users.yml
  150. +418 −0 website/i18n/en.json
  151. +17 −0 website/package.json
  152. +54 −0 website/pages/en/help.js
  153. +344 −0 website/pages/en/index.js
  154. +97 −0 website/pages/en/team.js
  155. +50 −0 website/pages/en/users.js
  156. +46 −0 website/sidebars.json
  157. +106 −0 website/siteConfig.js
  158. +41 −0 website/static/css/code-block-buttons.css
  159. +89 −0 website/static/css/custom.css
  160. +14 −0 website/static/img/color-logo.svg
  161. +89 −0 website/static/img/companies/angular-schule.svg
  162. BIN website/static/img/companies/b-com.png
  163. +38 −0 website/static/img/companies/bithost.svg
  164. +1 −0 website/static/img/companies/boxever.svg
  165. BIN website/static/img/companies/infotec.png
  166. BIN website/static/img/companies/juststar.png
  167. +11 −0 website/static/img/companies/klarna.svg
  168. BIN website/static/img/companies/logo-askul-01.gif
  169. +22 −0 website/static/img/companies/metaswitch.svg
  170. BIN website/static/img/companies/myworkout.png
  171. BIN website/static/img/companies/pepabo.png
  172. BIN website/static/img/companies/raiffeisen.png
  173. BIN website/static/img/companies/reprezen.png
  174. BIN website/static/img/companies/rest-united.png
  175. BIN website/static/img/companies/stingray.png
  176. +8 −0 website/static/img/companies/suva.svg
  177. +6 −0 website/static/img/companies/telstra.svg
  178. +6 −0 website/static/img/companies/unblu.svg
  179. BIN website/static/img/companies/zalando.jpg
  180. +1 −0 website/static/img/docusaurus.svg
  181. +1 −0 website/static/img/fa-logo.svg
  182. BIN website/static/img/favicon.png
  183. BIN website/static/img/favicon/favicon.ico
  184. +2 −0 website/static/img/icons/exchange.svg
  185. +1 −0 website/static/img/icons/github.svg
  186. +1 −0 website/static/img/icons/gitter.svg
  187. +2 −0 website/static/img/icons/newspaper-o.svg
  188. +2 −0 website/static/img/icons/pencil.svg
  189. +2 −0 website/static/img/icons/plug.svg
  190. +1 −0 website/static/img/icons/twitter.svg
  191. +1 −0 website/static/img/mono-logo.svg
  192. BIN website/static/img/oss_logo.png
  193. BIN website/static/img/tools/docker.png
  194. BIN website/static/img/tools/homebrew-256x256.png
  195. +1 −0 website/static/img/tools/npm.svg
  196. +48 −0 website/static/js/code-block-buttons.js
  197. +5,881 −0 website/yarn.lock
@@ -3,7 +3,6 @@ language: java
jdk:
- openjdk8


cache:
directories:
- $HOME/.m2
@@ -34,6 +33,7 @@ cache:
- $HOME/samples/server/petstore/cpp-pistache/pistache
- $HOME/.npm
- $HOME/.rvm/gems/ruby-2.4.1
- $HOME/website/node_modules/

services:
- docker
@@ -102,6 +102,7 @@ before_install:
gpg --keyserver keyserver.ubuntu.com --recv-key $SIGNING_KEY ;
gpg --check-trustdb ;
fi;
- pushd .; cd website; npm install; popd

install:
# Add Godeps dependencies to GOPATH and PATH
@@ -152,6 +153,15 @@ after_success:
- if [ $DOCKER_HUB_USERNAME ]; then echo "$DOCKER_HUB_PASSWORD" | docker login --username=$DOCKER_HUB_USERNAME --password-stdin && docker build -t $DOCKER_GENERATOR_IMAGE_NAME ./modules/openapi-generator-online && if [ ! -z "$TRAVIS_TAG" ]; then docker tag $DOCKER_GENERATOR_IMAGE_NAME:latest $DOCKER_GENERATOR_IMAGE_NAME:$TRAVIS_TAG; fi && if [ ! -z "$TRAVIS_TAG" ] || [ "$TRAVIS_BRANCH" = "master" ]; then docker push $DOCKER_GENERATOR_IMAGE_NAME && echo "Pushed to $DOCKER_GENERATOR_IMAGE_NAME"; fi; fi
## docker: build cli image and push to Docker Hub
- if [ $DOCKER_HUB_USERNAME ]; then echo "$DOCKER_HUB_PASSWORD" | docker login --username=$DOCKER_HUB_USERNAME --password-stdin && cp docker-entrypoint.sh ./modules/openapi-generator-cli && docker build -t $DOCKER_CODEGEN_CLI_IMAGE_NAME ./modules/openapi-generator-cli && if [ ! -z "$TRAVIS_TAG" ]; then docker tag $DOCKER_CODEGEN_CLI_IMAGE_NAME:latest $DOCKER_CODEGEN_CLI_IMAGE_NAME:$TRAVIS_TAG; fi && if [ ! -z "$TRAVIS_TAG" ] || [ "$TRAVIS_BRANCH" = "master" ]; then docker push $DOCKER_CODEGEN_CLI_IMAGE_NAME && echo "Pushed to $DOCKER_CODEGEN_CLI_IMAGE_NAME"; fi; fi
## publish latest website, variables below are secure environment variables which are unavailable to PRs from forks.
- if [ "$TRAVIS_BRANCH" = "master" ] && [ -z $TRAVIS_TAG ] && [ "$TRAVIS_PULL_REQUEST" == "false" ]; then
cd website;
git config --global user.name "${GH_NAME}";
git config --global user.email "${GH_EMAIL}";
echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc;
npm install;
GIT_USER="${GH_NAME}" npm run-script publish-gh-pages;
fi;

env:
- DOCKER_GENERATOR_IMAGE_NAME=openapitools/openapi-generator-online DOCKER_CODEGEN_CLI_IMAGE_NAME=openapitools/openapi-generator-cli NODE_ENV=test CC=gcc-5 CXX=g++-5
@@ -88,7 +88,7 @@ For old releases, please refer to the [**Release**](https://github.com/OpenAPITo

## [1.2 - Artifacts on Maven Central](#table-of-contents)

You can find our released artefacts on maven central:
You can find our released artifacts on maven central:

**Core:**
```xml
@@ -0,0 +1,34 @@
#!/bin/sh

SCRIPT="$0"
echo "# START SCRIPT: $SCRIPT"

conduct_in=CODE_OF_CONDUCT.md
contrib_in=CONTRIBUTING.md
conduct_out=docs/conduct.md
contrib_out=docs/contributing.md


\rm -rf "${conduct_out}"
\rm -rf "${contrib_out}"

cat > "${conduct_out}" << EOF
---
id: code-of-conduct
title: Code of Conduct
---
$(tail -n +3 "${conduct_in}")
EOF
echo "Wrote $(pwd)/${conduct_out}"

cat > "${contrib_out}" << EOF
---
id: contributing
title: Guidelines For Contributing
sidebar_label: Guidelines
---
$(tail -n +3 "${contrib_in}")
EOF
echo "Wrote $(pwd)/${contrib_out}"
@@ -37,6 +37,9 @@ declare -a scripts=("./bin/openapi3/ruby-client-petstore.sh"
"./bin/csharp-petstore.sh"
"./bin/meta-codegen.sh"
"./bin/utils/export_docs_generators.sh"
"./bin/utils/export_generators_docusaurus_index.sh"
"./bin/utils/copy-to-website.sh"
"./bin/utils/export_generators_readme.sh"
"./bin/go-petstore.sh"
"./bin/go-gin-petstore-server.sh")

@@ -14,6 +14,4 @@ fi

executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"

java -jar ${executable} config-help -g ${NAME} --named-header -o docs/generators/${NAME}.md

echo "Back to the [generators list](README.md)" >> docs/generators/${NAME}.md
java -jar ${executable} config-help -g ${NAME} --named-header --format markdown --markdown-header -o docs/generators/${NAME}.md
@@ -0,0 +1,20 @@
#!/bin/sh

SCRIPT="$0"
echo "# START SCRIPT: $SCRIPT"

executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"

\rm -rf docs/generators.md

cat > docs/generators.md << EOF
---
id: generators
title: Generators List
---
EOF

java -jar $executable list --docsite >> docs/generators.md

echo "Wrote $(pwd)/docs/generators.md"
@@ -5,4 +5,16 @@ echo "# START SCRIPT: $SCRIPT"

executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"

java -jar $executable list | sed -e 's/\([A-Z]*\) generators:/* \1 generators:/g' -e 's/- \([a-z0-9\-]*\)/- [\1]\(\1.md\)/g' > docs/generators/README.md
\rm -rf docs/generators.md

cat > docs/generators.md << EOF
---
id: generators
title: Generators List
---
EOF

java -jar $executable list | sed -e 's/\([A-Z]*\) generators:/* \1 generators:/g' -e 's/- \([a-z0-9\-]*\)/- [\1]\(generators\/\1.md\)/g' >> docs/generators.md

echo "Wrote $(pwd)/docs/generators.md"
@@ -0,0 +1,18 @@
version: "3"

services:
docusaurus:
build: .
ports:
- 3000:3000
- 35729:35729
volumes:
- ./docs:/app/docs
- ./website/blog:/app/website/blog
- ./website/core:/app/website/core
- ./website/i18n:/app/website/i18n
- ./website/pages:/app/website/pages
- ./website/static:/app/website/static
- ./website/sidebars.json:/app/website/sidebars.json
- ./website/siteConfig.js:/app/website/siteConfig.js
working_dir: /app/website
Oops, something went wrong.

0 comments on commit 6fe9a52

Please sign in to comment.