Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 4 additions & 10 deletions .github/workflows/website-root.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ on:
workflow_dispatch:
push:
branches:
- v1.15
- v1.16
pull_request:
types: [opened, synchronize, reopened, closed]
branches:
- v1.15
- v1.16

concurrency:
# Cancel the previously triggered build for only PR build.
Expand Down Expand Up @@ -50,23 +50,17 @@ jobs:
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"}
hugo ${STAGING_URL+-b "$STAGING_URL"} --minify
- 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/"
app_location: "/daprdocs/public"
output_location: "/"
skip_app_build: true
skip_deploy_on_missing_secrets: true
- name: Upload Hugo artifacts
uses: actions/upload-artifact@v4
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'
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ The following branches are currently maintained:

| Branch | Website | Description |
| ------------------------------------------------------------ | -------------------------- | ------------------------------------------------------------------------------------------------ |
| [v1.15](https://github.com/dapr/docs) (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here. |
| [v1.16](https://github.com/dapr/docs/tree/v1.16) (pre-release) | https://v1-16.docs.dapr.io/ | Pre-release documentation. Doc updates that are only applicable to v1.15+ go here. |
| [v1.16](https://github.com/dapr/docs) (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here. |
| [v1.17](https://github.com/dapr/docs/tree/v1.16) (pre-release) | https://v1-17.docs.dapr.io/ | Pre-release documentation. Doc updates that are only applicable to v1.16+ go here. |

For more information visit the [Dapr branch structure](https://docs.dapr.io/contributing/docs-contrib/contributing-docs/#branch-guidance) document.

Expand Down
69 changes: 33 additions & 36 deletions daprdocs/content/en/contributing/docs-contrib/maintainer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,24 +103,22 @@ These steps will prepare the latest release branch for archival.
git checkout -b release_v1.0
```

1. In VS Code, navigate to `/daprdocs/config.toml`.
1. Add the following TOML to the `# Versioning` section (around line 154):

```toml
version_menu = "v1.0"
version = "v1.0"
archived_version = true
url_latest_version = "https://docs.dapr.io"

[[params.versions]]
version = "v1.2 (preview)"
url = "v1-2.docs.dapr.io"
[[params.versions]]
version = "v1.1 (latest)"
url = "#"
[[params.versions]]
version = "v1.0"
url = "https://v1-0.docs.dapr.io"
1. In VS Code, navigate to `hugo.yaml` located in the root.
1. Add the following configuration to the `# Versioning` section (around line 121 and onwards):

```yaml
version_menu: "v1.0"
version: "v1.0"
archived_version: true
url_latest_version: "https://docs.dapr.io"

versions:
- version: v1.2 (preview)
url: https://v1-2.docs.dapr.io
- version: v1.1 (latest)
url: "#"
- version: v1.0
url: https://v1-0.docs.dapr.io
```

1. Delete `.github/workflows/website-root.yml`.
Expand All @@ -146,26 +144,25 @@ These steps will prepare the upcoming release branch for promotion to latest rel
git checkout -b release_v1.1
```

1. In VS Code, navigate to `/daprdocs/config.toml`.
1. Update line 1 to `baseURL - https://docs.dapr.io/`.
1. Update the `# Versioning` section (around line 154) to display the correct versions and tags:
1. In VS Code, navigate to `hugo.yaml` located in the root.
1. Update line 1 to `baseURL: https://docs.dapr.io/`.
1. Update the `# Versioning` section (around line 121 and onwards) to display the correct versions and tags:

```toml
```yaml
# Versioning
version_menu = "v1.1 (latest)"
version = "v1.1"
archived_version = false
url_latest_version = "https://docs.dapr.io"

[[params.versions]]
version = "v1.2 (preview)"
url = "v1-2.docs.dapr.io"
[[params.versions]]
version = "v1.1 (latest)"
url = "#"
[[params.versions]]
version = "v1.0"
url = "https://v1-0.docs.dapr.io"
version_menu: "v1.1 (latest)"
version: "v1.1"
archived_version: false
url_latest_version: https://docs.dapr.io
github_branch: v1.1

versions:
- version: v1.2 (preview)
url: https://v1-2.docs.dapr.io
- version: v1.1 (latest)
url: "#"
- version: v1.0
url: https://v1-0.docs.dapr.io
```

1. Navigate to `.github/workflows/website-root.yml`.
Expand Down
2 changes: 1 addition & 1 deletion daprdocs/layouts/_shortcodes/dapr-latest-version.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{{- if .Get "short" }}1.15{{ else if .Get "long" }}1.15.5{{ else if .Get "cli" }}1.15.1{{ else }}1.15.1{{ end -}}
{{- if .Get "short" }}1.16{{ else if .Get "long" }}1.16.0{{ else if .Get "cli" }}1.16.0{{ else }}1.16.0{{ end -}}
25 changes: 14 additions & 11 deletions hugo.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
baseURL: https://v1-16.docs.dapr.io
baseURL: https://docs.dapr.io
title: Dapr Docs

# Output directory for generated site
Expand Down Expand Up @@ -117,21 +117,22 @@ params:

# First one is picked as the Twitter card image if not set on page.
# images: [images/project-illustration.png]


# Versioning
# Menu title if your navbar has a versions selector to access old versions of your site.
# This menu appears only if you have at least one [params.versions] set.
version_menu: v1.16 (preview)

# Flag used in the "version-banner" partial to decide whether to display a
# banner on every page indicating that this is an archived version of the docs.
# Set this flag to "true" if you want to display the banner.
archived_version: false
version_menu: v1.16 (latest)

# The version number for the version of the docs represented in this doc set.
# Used in the "version-banner" partial to display a version number for the
# current doc set.
version: v1.16

# Flag used in the "version-banner" partial to decide whether to display a
# banner on every page indicating that this is an archived version of the docs.
# Set this flag to "true" if you want to display the banner.
archived_version: false

# A link to latest version of the docs. Used in the "version-banner" partial to
# point people to the main doc site.
url_latest_version: https://docs.dapr.io
Expand All @@ -150,10 +151,12 @@ params:
github_branch: v1.16

versions:
- version: v1.16 (preview)
- version: v1.17 (preview)
url: https://v1-17.docs.dapr.io
- version: v1.16 (latest)
url: "#"
- version: v1.15 (latest)
url: "https://docs.dapr.io"
- version: v1.15
url: https://v1-15.docs.dapr.io
- version: v1.14
url: https://v1-14.docs.dapr.io
- version: v1.13
Expand Down
Loading