Skip to content

Commit e06353b

Browse files
authored
Merge branch 'main' into abhishek/consul-k8s-cli-proxy-docs
2 parents 1052cd1 + 62a4390 commit e06353b

File tree

16,939 files changed

+1679248
-15670
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

16,939 files changed

+1679248
-15670
lines changed
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<!--
2+
**Merge branch**
3+
4+
Make sure you create your PR against the correct **base** branch. For instructions, refer to
5+
GitHub's **Change the branch range and destination repository guide** (https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
6+
7+
If your content is an update to:
8+
9+
- Currently published content
10+
11+
Choose **base: main** when you are updating published documentation, and you
12+
want your changes published when the PR is merged. We publish Consul content
13+
from the `main` branch.
14+
15+
- Upcoming Consul release
16+
17+
Choose the branch for the Consul release that your content is for. Consul
18+
release branches use the `consul/<exact-release-number>` format. If you are not
19+
able to find the upcoming Consul release branch that you are looking for,
20+
contact the tech writer that works with the Consul team.
21+
22+
**Backports**
23+
24+
This repo stores previous version docs in folders instead of branches. There are
25+
no backport labels. If you backported your code PR to previous branches, update
26+
the docs content in the corresponding folders. For example, if the current
27+
release is 1.22.x and you backported your code to 1.21.x and 1.20.x, update the docs content
28+
in the v1.22.x, v1.21.x, and v1.20.x folders.
29+
-->
30+
31+
## Description
32+
33+
<!-- Please describe why you're making this change and point out any important details the reviewers
34+
should be aware of.
35+
36+
Include the target release as well as prior versions if applicable.
37+
-->
38+
39+
## Links
40+
<!--
41+
Please include links to GitHub issues, documentation, or similar which is relevant to this PR. If
42+
this is a bug fix, please ensure related issues are linked so they will close when this PR is
43+
merged.
44+
45+
Jira: [<jira-ticket-number>] // for example, Jira: [CE-1001] GH-Jira integration generates the link and updates the Jira ticket.
46+
GitHub Issue: <issue-link>
47+
Deploy previews:
48+
49+
The bot does publish a root-level link to the deploy preview,
50+
but it's nice to include a direct link to your content so the reviewers don't have to navigate to your pages.
51+
-->
52+
53+
## Contributor checklists
54+
55+
Review urgency:
56+
57+
- [ ] ASAP: Bug fixes, broken content, imminent releases
58+
- [ ] 3 days: Small changes, easy reviews
59+
- [ ] 1 week: Default expectation
60+
- [ ] Best effort: No urgency
61+
62+
Pull request:
63+
64+
- [ ] Verify that the PR is set to merge into the correct base branch
65+
- [ ] Verify that all status checks passed
66+
- [ ] Verify that the preview environment deployed successfully
67+
- [ ] Add additional reviewers if they are not part of assigned groups
68+
69+
Content:
70+
71+
- [ ] I added redirects for any moved or removed pages
72+
- [ ] I followed the [Education style guide](https://github.com/hashicorp/web-unified-docs/tree/main/docs/style-guide)
73+
- [ ] I looked at the local or Vercel build to make sure the content rendered correctly
74+
75+
## Reviewer checklist
76+
77+
- [ ] This PR is set to merge into the correct base branch.
78+
- [ ] The content does not contain technical inaccuracies.
79+
- [ ] The content follows the Education content and style guides.
80+
- [ ] I have verified and tested changes to instructions for end users.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
### What
2+
<!-- Explain what you changed and provide a list of changed page names. -->
3+
4+
### Why
5+
<!-- Explain why this change is necessary and how it benefits users. -->
6+
7+
### Screenshots
8+
<!-- Optional. Show additions to the sidebar or new formatting. -->
9+
10+
----------
11+
12+
### Merge Checklist
13+
_If items do not apply to your changes, add (N/A) and mark them as complete._
14+
15+
#### Pull Request
16+
- [ ] Description links to related pull requests or issues, if any.
17+
18+
#### Content
19+
- [ ] Redirects have been added to `content/terraform-docs-common/redirects.jsonc` for moved, renamed, or deleted pages.
20+
- [ ] API documentation and the API Changelog have been updated.
21+
- [ ] Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
22+
- [ ] Pages with related content are updated and link to this content when appropriate.
23+
- [ ] Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
24+
- [ ] New pages have metadata (page name and description) at the top.
25+
- [ ] New images are 2048 px wide. They have HashiCorp standard annotation color (#F92672) and format (rectangle with rounded corners), blurred sensitive details (e.g. credentials, usernames, user icons), and descriptive alt text in the markdown for accessibility.
26+
- [ ] New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
27+
- [ ] UI elements (button names, page names, etc.) are bolded.
28+
- [ ] The Vercel website preview successfully deployed.
29+
30+
#### Reviews
31+
- [ ] I or someone else reviewed the content for technical accuracy.
32+
- [ ] I or someone else reviewed the content for typos, punctuation, spelling, and grammar.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
### What
2+
<!-- Explain what you changed and provide a list of changed page names. -->
3+
4+
### Why
5+
<!-- Explain why this change is necessary and how it benefits users. -->
6+
7+
### Screenshots
8+
<!-- Optional. Show additions to the sidebar or new formatting. -->
9+
10+
----------
11+
12+
### Merge Checklist
13+
_If items do not apply to your changes, add (N/A) and mark them as complete._
14+
15+
#### Pull Request
16+
- [ ] Description links to related pull requests or issues, if any.
17+
18+
#### Content
19+
- [ ] You added redirects to `content/terraform-docs-common/redirects.jsonc` for moved, renamed, or deleted pages **across all affected versions**. Refer to [Redirects](https://github.com/hashicorp/web-unified-docs/blob/main/docs/content-guide/redirects.md#example-redirects) for examples and guidance.
20+
- [ ] Links to related content where appropriate (e.g., CLI, language, API endpoints, permissions, etc.).
21+
- [ ] Pages with related content are updated and link to this content when appropriate.
22+
- [ ] Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
23+
- [ ] New pages have metadata (page name and description) at the top.
24+
- [ ] New images are 2048 px wide. They have HashiCorp standard annotation color (#F92672) and format (rectangle with rounded corners), blurred sensitive details (e.g. credentials, usernames, user icons), and descriptive alt text in the markdown for accessibility.
25+
- [ ] New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
26+
- [ ] UI elements (button names, page names, etc.) are bolded.
27+
- [ ] The Vercel website preview successfully deployed.
28+
29+
#### Reviews
30+
- [ ] I or someone else reviewed the content for technical accuracy.
31+
- [ ] I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

.github/actions/reload-dev-portal/action.yml

Lines changed: 0 additions & 86 deletions
This file was deleted.

.github/advanced-issue-labeler.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88

99
policy:
10-
- template: [ docs.yml]
10+
- template: [docs.yml]
1111
section:
1212
- id: [product]
1313
label:
@@ -35,4 +35,6 @@ policy:
3535
keys: ['Waypoint']
3636
- name: 'Triage'
3737
keys: ['No product', 'Other product']
38+
- name: 'Runtime'
39+
keys: ['Nomad', 'Consul']
3840

.github/labeler.yml

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,19 @@ HCP:
4444
'content/hcp-docs/**'
4545
]
4646

47+
# Add 'Nomad' label to changes under 'content/nomad'
48+
#
49+
# Label | Rule
50+
# --------------- | ------------------------------------------------------------
51+
# Nomad | Default; applies to all doc updates
52+
53+
Nomad:
54+
- any:
55+
- changed-files:
56+
- any-glob-to-any-file: [
57+
'content/nomad/**'
58+
]
59+
4760
# Add 'Packer' label to changes under 'content/packer'
4861
#
4962
# Label | Rule
@@ -217,15 +230,23 @@ Waypoint:
217230
'content/hcp-docs/content/docs/waypoint/**'
218231
]
219232

220-
# Add 'HCP Docs' label to changes under 'content/hcp-docs'
233+
# Add 'Runtime' label to changes under 'content/consul', 'content/nomad', 'content/hcp-docs/content/docs/cli' and 'content/hcp-docs/content/docs/hcp'
221234
#
222235
# Label | Rule
223236
# --------------- | ------------------------------------------------------------
224-
# HCP Docs | Default; applies to all doc updates
237+
# Runtime | Default; applies to all doc updates
238+
# Runtime | Updates to Consul documentation
239+
# Runtime | Updates to Nomad documentation
240+
# Runtime | Updates to HCP CLI documentation
241+
# Runtime | Updates to HCP platform documentation
242+
225243

226-
HCP Docs:
244+
Runtime:
227245
- any:
228246
- changed-files:
229247
- any-glob-to-any-file: [
230-
'content/hcp-docs/**'
231-
]
248+
'content/consul/**',
249+
'content/nomad/**',
250+
'content/hcp-docs/content/docs/cli/**',
251+
'content/hcp-docs/content/docs/hcp/**'
252+
]

.github/pull_request_template.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
Please go to the `Preview` tab and select the appropriate template:
22

3+
* [Consul](?expand=1&labels=Consul&title=Consul+Docs&template=consul_pull_request_template.md)
34
* [HCP services](?expand=1&template=hcp_pull_request_template.md)
45
* [Nomad](?expand=1&labels=Nomad&title=Nomad+Docs&template=nomad_pull_request_template.md)
6+
7+
### Terraform
8+
9+
* [HCP Terraform](?expand=1&labels=hcp,terraform&title=HCP+Terraform+Docs&template=hcp_terraform_pull_request_template.md)
10+
* [Terraform](?expand=1&labels=terraform&title=Terraform+Docs&template=terraform_pull_request_template.md)
511
* [Terraform Enterprise](?expand=1&template=ptfe_release_pull_request_template.md)

.github/workflows/algolia-prod.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
name: Algolia Sync - Production
22

33
on:
4+
workflow_dispatch:
45
push:
56
branches:
67
- 'main'

.github/workflows/build-pr-preview.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,14 +105,17 @@ jobs:
105105
cache: 'npm'
106106
node-version-file: 'package.json'
107107

108+
- name: Generate cache manifest
109+
run: git ls-files -z -- '*.js' '*.mjs' '*.ts' '*.tsx' '*.mdx' '*.json' | xargs -0 git hash-object > cache-key.txt
110+
108111
- name: Use cache
109112
uses: actions/cache@d4323d4df104b026a6aa633fdb11d772146be0bf # v4.2.2
110113
with:
111114
path: |
112115
~/.npm
113116
${{ github.workspace }}/.next/cache
114117
# Generate a new cache whenever packages or source files change.
115-
key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}-${{ hashFiles('**/*.js', '**/*.mjs', '**/*.ts', '**/*.tsx', '**/*.mdx', '**/*.json') }}
118+
key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}-${{ hashFiles('cache-key.txt') }}
116119
# If source files changed but packages didn't, rebuild from a prior cache.
117120
restore-keys: |
118121
${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}-

.github/workflows/create-tfe-release-notes.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ on:
2525
default: true
2626

2727
env:
28-
GITHUB_TOKEN: ${{ secrets.TFE_GITHUB_TOKEN_010623 }}
28+
GITHUB_TOKEN: ${{ secrets.TFE_GITHUB_TOKEN }}
2929
GITHUB_USER: [email protected]
3030
DEV: ${{ inputs.dev-mode }}
3131
NOTIFY: ${{ inputs.notify }}

0 commit comments

Comments
 (0)