From 46bed119275a7f40b1a368769f2ddc69bad1a03e Mon Sep 17 00:00:00 2001 From: Hannah Hunter Date: Mon, 8 Jul 2024 16:53:09 -0400 Subject: [PATCH 1/4] initial endgame stuff for 1.13 Signed-off-by: Hannah Hunter --- .github/workflows/website-root.yml | 110 ----------------------------- README.md | 4 +- daprdocs/config.toml | 15 ++-- 3 files changed, 11 insertions(+), 118 deletions(-) delete mode 100644 .github/workflows/website-root.yml diff --git a/.github/workflows/website-root.yml b/.github/workflows/website-root.yml deleted file mode 100644 index 94f09c48b6d..00000000000 --- a/.github/workflows/website-root.yml +++ /dev/null @@ -1,110 +0,0 @@ -name: Azure Static Web App Root - -on: - workflow_dispatch: - push: - branches: - - v1.13 - pull_request: - types: [opened, synchronize, reopened, closed] - branches: - - v1.13 - -concurrency: - # Cancel the previously triggered build for only PR build. - group: website-${{ github.event.pull_request.number || github.sha }} - cancel-in-progress: true - -jobs: - build_and_deploy_job: - name: Build Hugo Website - if: github.event.action != 'closed' - runs-on: ubuntu-latest - env: - SWA_BASE: 'proud-bay-0e9e0e81e' - HUGO_ENV: production - steps: - - name: Checkout docs repo - uses: actions/checkout@v3 - with: - submodules: true - - name: Setup Node - uses: actions/setup-node@v2 - with: - node-version: '14' - - name: Setup Hugo - uses: peaceiris/actions-hugo@v2.5.0 - with: - hugo-version: 0.102.3 - extended: true - - name: Setup Docsy - run: | - cd daprdocs - git submodule update --init --recursive - sudo npm install -D --save autoprefixer - sudo npm install -D --save postcss-cli - - name: Build Hugo Website - run: | - cd daprdocs - git config --global --add safe.directory /github/workspace - if [ $GITHUB_EVENT_NAME == 'pull_request' ]; then - STAGING_URL="https://${SWA_BASE}-${{github.event.number}}.westus2.azurestaticapps.net/" - fi - hugo ${STAGING_URL+-b "$STAGING_URL"} - - name: Deploy docs site - uses: Azure/static-web-apps-deploy@v1 - with: - azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_PROUD_BAY_0E9E0E81E }} - repo_token: ${{ secrets.GITHUB_TOKEN }} - action: "upload" - app_location: "daprdocs/public/" - api_location: "daprdocs/public/" - output_location: "" - skip_app_build: true - skip_deploy_on_missing_secrets: true - - name: Upload Hugo artifacts - uses: actions/upload-artifact@v3 - with: - name: hugo_build - path: ./daprdocs/public/ - if-no-files-found: error - - close_staging_site: - if: github.event_name == 'pull_request' && github.event.action == 'closed' - runs-on: ubuntu-latest - name: Close Pull Request Job - steps: - - name: Close Pull Request - id: closepullrequest - uses: Azure/static-web-apps-deploy@v1 - with: - azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_PROUD_BAY_0E9E0E81E }} - action: "close" - skip_deploy_on_missing_secrets: true - - algolia_index: - name: Index site for Algolia - if: github.event_name == 'push' - needs: ['build_and_deploy_job'] - runs-on: ubuntu-latest - env: - ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }} - ALGOLIA_API_WRITE_KEY: ${{ secrets.ALGOLIA_API_WRITE_KEY }} - ALGOLIA_INDEX_NAME: daprdocs - steps: - - name: Checkout docs repo - uses: actions/checkout@v2 - with: - submodules: false - - name: Download Hugo artifacts - uses: actions/download-artifact@v3 - with: - name: hugo_build - path: site/ - - name: Install Python packages - run: | - pip install --upgrade bs4 - pip install --upgrade 'algoliasearch>=2.0,<3.0' - - name: Index site - run: python ./.github/scripts/algolia.py ./site - \ No newline at end of file diff --git a/README.md b/README.md index c8a4a8ada7b..dd2ccfe511d 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ The following branches are currently maintained: | Branch | Website | Description | | ------------------------------------------------------------ | -------------------------- | ------------------------------------------------------------------------------------------------ | -| [v1.13](https://github.com/dapr/docs) (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here. | -| [v1.14](https://github.com/dapr/docs/tree/v1.14) (pre-release) | https://v1-14.docs.dapr.io/ | Pre-release documentation. Doc updates that are only applicable to v1.14+ go here. | +| [v1.14](https://github.com/dapr/docs) (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here. | +| [v1.15](https://github.com/dapr/docs/tree/v1.15) (pre-release) | https://v1-15.docs.dapr.io/ | Pre-release documentation. Doc updates that are only applicable to v1.15+ go here. | For more information visit the [Dapr branch structure](https://docs.dapr.io/contributing/docs-contrib/contributing-docs/#branch-guidance) document. diff --git a/daprdocs/config.toml b/daprdocs/config.toml index f9f3c36e9cf..50aab0a26d6 100644 --- a/daprdocs/config.toml +++ b/daprdocs/config.toml @@ -1,5 +1,5 @@ # Site Configuration -baseURL = "https://docs.dapr.io" +baseURL = "https://v1-13.docs.dapr.io" title = "Dapr Docs" theme = "docsy" disableFastRender = true @@ -191,17 +191,20 @@ github_subdir = "daprdocs" github_branch = "v1.13" # Versioning -version_menu = "v1.13 (latest)" +version_menu = "v1.13" version = "v1.13" -archived_version = false +archived_version = true url_latest_version = "https://docs.dapr.io" [[params.versions]] - version = "v1.14 (preview)" - url = "https://v1-14.docs.dapr.io" + version = "v1.15 (preview)" + url = "https://v1-15.docs.dapr.io" [[params.versions]] - version = "v1.13 (latest)" + version = "v1.14 (latest)" url = "#" +[[params.versions]] + version = "v1.13" + url = "https://v1-13.docs.dapr.io" [[params.versions]] version = "v1.12" url = "https://v1-12.docs.dapr.io" From b277085be715b67fbc23e7017d8f48867c83ee6b Mon Sep 17 00:00:00 2001 From: Marc Duiker Date: Mon, 12 Aug 2024 13:10:02 +0000 Subject: [PATCH 2/4] Override head partial to ignore deprecated GA script Signed-off-by: Marc Duiker --- daprdocs/layouts/partials/head.html | 45 +++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 daprdocs/layouts/partials/head.html diff --git a/daprdocs/layouts/partials/head.html b/daprdocs/layouts/partials/head.html new file mode 100644 index 00000000000..7bf5057343f --- /dev/null +++ b/daprdocs/layouts/partials/head.html @@ -0,0 +1,45 @@ + + +{{ hugo.Generator }} +{{ range .AlternativeOutputFormats -}} + +{{ end -}} + +{{ $outputFormat := partial "outputformat.html" . -}} +{{ if and hugo.IsProduction (ne $outputFormat "print") -}} + +{{ else -}} + +{{ end -}} + +{{ partialCached "favicons.html" . }} + + {{- if .IsHome -}} + {{ .Site.Title -}} + {{ else -}} + {{ with .Title }}{{ . }} | {{ end -}} + {{ .Site.Title -}} + {{ end -}} + +{{ $desc := .Page.Description | default (.Page.Content | safeHTML | truncate 150) -}} + +{{ template "_internal/opengraph.html" . -}} +{{ template "_internal/schema.html" . -}} +{{ template "_internal/twitter_cards.html" . -}} +{{ partialCached "head-css.html" . "asdf" -}} + +{{ if .Site.Params.offlineSearch -}} + +{{ end -}} + +{{ if .Site.Params.prism_syntax_highlighting -}} + +{{ end -}} + +{{ partial "hooks/head-end.html" . -}} \ No newline at end of file From 7492d5c108b249c4cc02e91da92b0e1eb858c4ef Mon Sep 17 00:00:00 2001 From: Whit Waldo Date: Thu, 15 Aug 2024 16:11:19 -0500 Subject: [PATCH 3/4] Listed missing HTTP and gRPC endpoint envvars used (#4313) * Listed missing HTTP and gRPC endpoint envvars used Signed-off-by: Whit Waldo * Added examples Signed-off-by: Whit Waldo --------- Signed-off-by: Whit Waldo Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> --- daprdocs/content/en/reference/environment/_index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/daprdocs/content/en/reference/environment/_index.md b/daprdocs/content/en/reference/environment/_index.md index d5ed2d529c1..afff9cbca82 100644 --- a/daprdocs/content/en/reference/environment/_index.md +++ b/daprdocs/content/en/reference/environment/_index.md @@ -14,7 +14,9 @@ The following table lists the environment variables used by the Dapr runtime, CL | APP_PORT | Dapr sidecar | The port your application is listening on | | APP_API_TOKEN | Your application | The token used by the application to authenticate requests from Dapr API. Read [authenticate requests from Dapr using token authentication]({{< ref app-api-token >}}) for more information. | | DAPR_HTTP_PORT | Your application | The HTTP port that the Dapr sidecar is listening on. Your application should use this variable to connect to Dapr sidecar instead of hardcoding the port value. Set by the Dapr CLI run command for self-hosted or injected by the `dapr-sidecar-injector` into all the containers in the pod. | +| DAPR_HTTP_ENDPOINT | Your application | The HTTP endpoint that the Dapr sidecar is listening on. Your application should use this variable to change the endpoint used to connect to the Dapr sidecar instead of hardcoding an alternative hostname. It is expected that this value minimally include the schema and hostname: `https://dapr.io` would indicate an `https` schema, a hostname of `dapr.io` and the implied (via the `https` scheme) port of `443` | | DAPR_GRPC_PORT | Your application | The gRPC port that the Dapr sidecar is listening on. Your application should use this variable to connect to Dapr sidecar instead of hardcoding the port value. Set by the Dapr CLI run command for self-hosted or injected by the `dapr-sidecar-injector` into all the containers in the pod. | +| DAPR_GRPC_ENDPOINT | Your application | The gRPC endpoint that the Dapr sidecar is listening on. Your application should use this variable to change the endpoint used to connect to the Dapr sidecar instead of hardcoding an alternative hostname. It is expected that this value minimally include the schema and hostname: `http://grpc.dapr.io` would indicate an `http` schema, a hostname of `dapr.io` and the implied (via the `http` scheme) port of `80`| | DAPR_API_TOKEN | Dapr sidecar | The token used for Dapr API authentication for requests from the application. [Enable API token authentication in Dapr]({{< ref api-token >}}). | | NAMESPACE | Dapr sidecar | Used to specify a component's [namespace in self-hosted mode]({{< ref component-scopes >}}). | | DAPR_DEFAULT_IMAGE_REGISTRY | Dapr CLI | In self-hosted mode, it is used to specify the default container registry to pull images from. When its value is set to `GHCR` or `ghcr`, it pulls the required images from Github container registry. To default to Docker hub, unset this environment variable. | From 9613b1cea349adf133afa1577e06b98838ede7f1 Mon Sep 17 00:00:00 2001 From: Hannah Hunter Date: Mon, 6 Jan 2025 11:13:53 -0500 Subject: [PATCH 4/4] update python versions Signed-off-by: Hannah Hunter --- .github/workflows/link_validation.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/link_validation.yaml b/.github/workflows/link_validation.yaml index 4b7840e3cb1..350f8407a33 100644 --- a/.github/workflows/link_validation.yaml +++ b/.github/workflows/link_validation.yaml @@ -13,7 +13,7 @@ jobs: validate: runs-on: ubuntu-latest env: - PYTHON_VER: 3.7 + PYTHON_VER: 3.12 steps: - uses: actions/checkout@v2 - name: Check Microsoft URLs do not pin localized versions @@ -27,7 +27,7 @@ jobs: exit 1 fi - name: Set up Python ${{ env.PYTHON_VER }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v5 with: python-version: ${{ env.PYTHON_VER }} - name: Install dependencies