diff --git a/.github/workflows/hugo.yaml b/.github/workflows/hugo.yaml new file mode 100644 index 000000000000..b35152997036 --- /dev/null +++ b/.github/workflows/hugo.yaml @@ -0,0 +1,79 @@ +# Workflow for building and deploying a Hugo site to GitHub Pages +name: Deploy Hugo site to Pages + +on: + # Runs on pushes targeting the default branch + # TODO @alicejli: Update this to only run on release / update to docs + push: + branches: + - main + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +# Default to bash +defaults: + run: + shell: bash + +jobs: + # Build job + build: + runs-on: ubuntu-latest + env: + HUGO_VERSION: 0.111.3 + steps: + - name: Install Hugo CLI + run: | + wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \ + && sudo dpkg -i ${{ runner.temp }}/hugo.deb + - name: Install Dart Sass Embedded + run: sudo snap install dart-sass-embedded + - name: Checkout + uses: actions/checkout@v3 + with: + submodules: recursive + fetch-depth: 0 + - name: Setup Pages + id: pages + uses: actions/configure-pages@v3 + - name: Install Node.js dependencies + run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true && npm install postcss-cli" + - name: Build with Hugo + env: + # For maximum backward compatibility with Hugo modules + HUGO_ENVIRONMENT: production + HUGO_ENV: production + run: | + hugo \ + --gc \ + --minify \ + --baseURL "${{ steps.pages.outputs.base_url }}/" + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: ./public + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 \ No newline at end of file diff --git a/.gitignore b/.gitignore index 267cfea8cd60..09150cf7f38e 100644 --- a/.gitignore +++ b/.gitignore @@ -24,7 +24,7 @@ nosetests.xml .classpath # Built documentation -docs/ +site/ # Python utilities *.pyc diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 000000000000..b76244d3b5e2 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "themes/docsy"] + path = themes/docsy + url = https://github.com/google/docsy.git diff --git a/site/content/en/docs/_index.md b/site/content/en/docs/_index.md new file mode 100755 index 000000000000..3fb7d8bd414b --- /dev/null +++ b/site/content/en/docs/_index.md @@ -0,0 +1,35 @@ + +--- +title: "Javadocs Documentation" +linkTitle: "Documentation" +no_list: true +weight: 20 +menu: + main: + weight: 20 +--- + +{{% pageinfo %}} +Please refer to [Google Cloud Docs](https://cloud.google.com/java/docs) for more information on cloud product offerings, guides, and tutorials. +{{% /pageinfo %}} + +## [hello!](/lychee_wink.gif) + +This site contains Javadoc reference documentation for all Cloud SDK modules. + +If you are using [Google Cloud Client Libraries](https://cloud.google.com/apis/docs/client-libraries-explained), the recommended approach is to use the [BOM](https://cloud.google.com/java/docs/bom) to ensure dependency compatibility. + +Note that this site contains Javadoc reference documentation for **all** published Cloud SDK modules, including modules that may not be associated with a libraries-bom version. To see all available versions for a module, please click on the appropriate module in the lefthand navigation. + +--- +Here is a list of all the published libraries-bom versions and the modules included in them: + +## **libraries-bom-26.11.0** +### [google-cloud-apikeys-0.11.0](/google-cloud-apikeys/0.11.0/) + +## **libraries-bom-26.10.0** +### [google-cloud-apikeys-0.10.0](/google-cloud-apikeys/0.10.0/) + + + + diff --git a/themes/docsy b/themes/docsy new file mode 160000 index 000000000000..29e1decb870f --- /dev/null +++ b/themes/docsy @@ -0,0 +1 @@ +Subproject commit 29e1decb870f38915ee8ca27f7414ff3cb5286e7