Skip to content

Commit bbb5516

Browse files
marcduikermsfussell
authored andcommitted
Prepare branch 1.16 to be latest (#4858)
Signed-off-by: Marc Duiker <[email protected]> Co-authored-by: Mark Fussell <[email protected]>
1 parent c08077d commit bbb5516

File tree

5 files changed

+54
-60
lines changed

5 files changed

+54
-60
lines changed

.github/workflows/website-root.yml

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ on:
44
workflow_dispatch:
55
push:
66
branches:
7-
- v1.15
7+
- v1.16
88
pull_request:
99
types: [opened, synchronize, reopened, closed]
1010
branches:
11-
- v1.15
11+
- v1.16
1212

1313
concurrency:
1414
# Cancel the previously triggered build for only PR build.
@@ -50,23 +50,17 @@ jobs:
5050
if [ $GITHUB_EVENT_NAME == 'pull_request' ]; then
5151
STAGING_URL="https://${SWA_BASE}-${{github.event.number}}.westus2.azurestaticapps.net/"
5252
fi
53-
hugo ${STAGING_URL+-b "$STAGING_URL"}
53+
hugo ${STAGING_URL+-b "$STAGING_URL"} --minify
5454
- name: Deploy docs site
5555
uses: Azure/static-web-apps-deploy@v1
5656
with:
5757
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_PROUD_BAY_0E9E0E81E }}
5858
repo_token: ${{ secrets.GITHUB_TOKEN }}
5959
action: "upload"
60-
app_location: "/daprdocs/public/"
60+
app_location: "/daprdocs/public"
6161
output_location: "/"
6262
skip_app_build: true
6363
skip_deploy_on_missing_secrets: true
64-
- name: Upload Hugo artifacts
65-
uses: actions/upload-artifact@v4
66-
with:
67-
name: hugo_build
68-
path: ./daprdocs/public/
69-
if-no-files-found: error
7064

7165
close_staging_site:
7266
if: github.event_name == 'pull_request' && github.event.action == 'closed'

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ The following branches are currently maintained:
1616

1717
| Branch | Website | Description |
1818
| ------------------------------------------------------------ | -------------------------- | ------------------------------------------------------------------------------------------------ |
19-
| [v1.15](https://github.com/dapr/docs) (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here. |
20-
| [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. |
19+
| [v1.16](https://github.com/dapr/docs) (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here. |
20+
| [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. |
2121

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

daprdocs/content/en/contributing/docs-contrib/maintainer-guide.md

Lines changed: 33 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -103,24 +103,22 @@ These steps will prepare the latest release branch for archival.
103103
git checkout -b release_v1.0
104104
```
105105

106-
1. In VS Code, navigate to `/daprdocs/config.toml`.
107-
1. Add the following TOML to the `# Versioning` section (around line 154):
108-
109-
```toml
110-
version_menu = "v1.0"
111-
version = "v1.0"
112-
archived_version = true
113-
url_latest_version = "https://docs.dapr.io"
114-
115-
[[params.versions]]
116-
version = "v1.2 (preview)"
117-
url = "v1-2.docs.dapr.io"
118-
[[params.versions]]
119-
version = "v1.1 (latest)"
120-
url = "#"
121-
[[params.versions]]
122-
version = "v1.0"
123-
url = "https://v1-0.docs.dapr.io"
106+
1. In VS Code, navigate to `hugo.yaml` located in the root.
107+
1. Add the following configuration to the `# Versioning` section (around line 121 and onwards):
108+
109+
```yaml
110+
version_menu: "v1.0"
111+
version: "v1.0"
112+
archived_version: true
113+
url_latest_version: "https://docs.dapr.io"
114+
115+
versions:
116+
- version: v1.2 (preview)
117+
url: https://v1-2.docs.dapr.io
118+
- version: v1.1 (latest)
119+
url: "#"
120+
- version: v1.0
121+
url: https://v1-0.docs.dapr.io
124122
```
125123
126124
1. Delete `.github/workflows/website-root.yml`.
@@ -146,26 +144,25 @@ These steps will prepare the upcoming release branch for promotion to latest rel
146144
git checkout -b release_v1.1
147145
```
148146

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

153-
```toml
151+
```yaml
154152
# Versioning
155-
version_menu = "v1.1 (latest)"
156-
version = "v1.1"
157-
archived_version = false
158-
url_latest_version = "https://docs.dapr.io"
159-
160-
[[params.versions]]
161-
version = "v1.2 (preview)"
162-
url = "v1-2.docs.dapr.io"
163-
[[params.versions]]
164-
version = "v1.1 (latest)"
165-
url = "#"
166-
[[params.versions]]
167-
version = "v1.0"
168-
url = "https://v1-0.docs.dapr.io"
153+
version_menu: "v1.1 (latest)"
154+
version: "v1.1"
155+
archived_version: false
156+
url_latest_version: https://docs.dapr.io
157+
github_branch: v1.1
158+
159+
versions:
160+
- version: v1.2 (preview)
161+
url: https://v1-2.docs.dapr.io
162+
- version: v1.1 (latest)
163+
url: "#"
164+
- version: v1.0
165+
url: https://v1-0.docs.dapr.io
169166
```
170167

171168
1. Navigate to `.github/workflows/website-root.yml`.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +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 -}}
1+
{{- if .Get "short" }}1.16{{ else if .Get "long" }}1.16.0{{ else if .Get "cli" }}1.16.0{{ else }}1.16.0{{ end -}}

hugo.yaml

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
baseURL: https://v1-16.docs.dapr.io
1+
baseURL: https://docs.dapr.io
22
title: Dapr Docs
33

44
# Output directory for generated site
@@ -117,21 +117,22 @@ params:
117117

118118
# First one is picked as the Twitter card image if not set on page.
119119
# images: [images/project-illustration.png]
120-
120+
121+
# Versioning
121122
# Menu title if your navbar has a versions selector to access old versions of your site.
122123
# This menu appears only if you have at least one [params.versions] set.
123-
version_menu: v1.16 (preview)
124-
125-
# Flag used in the "version-banner" partial to decide whether to display a
126-
# banner on every page indicating that this is an archived version of the docs.
127-
# Set this flag to "true" if you want to display the banner.
128-
archived_version: false
124+
version_menu: v1.16 (latest)
129125

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

131+
# Flag used in the "version-banner" partial to decide whether to display a
132+
# banner on every page indicating that this is an archived version of the docs.
133+
# Set this flag to "true" if you want to display the banner.
134+
archived_version: false
135+
135136
# A link to latest version of the docs. Used in the "version-banner" partial to
136137
# point people to the main doc site.
137138
url_latest_version: https://docs.dapr.io
@@ -150,10 +151,12 @@ params:
150151
github_branch: v1.16
151152

152153
versions:
153-
- version: v1.16 (preview)
154+
- version: v1.17 (preview)
155+
url: https://v1-17.docs.dapr.io
156+
- version: v1.16 (latest)
154157
url: "#"
155-
- version: v1.15 (latest)
156-
url: "https://docs.dapr.io"
158+
- version: v1.15
159+
url: https://v1-15.docs.dapr.io
157160
- version: v1.14
158161
url: https://v1-14.docs.dapr.io
159162
- version: v1.13

0 commit comments

Comments
 (0)