Skip to content

Commit cfe6b8b

Browse files
committed
feat: Migrate Packer documentation to unified-docs system
Successfully integrated Packer website content into the web-unified-docs platform with full functionality. ## What's Working - **Docker Setup**: Both unified-docs-api and dev-portal containers running successfully - **Content Migration**: All Packer docs, examples, data, and assets properly migrated - **Web Interface**: Packer documentation accessible at http://localhost:3000/packer - **API Integration**: Redirects API working correctly (/api/content/packer/redirects) - **Product Support**: Packer listed as supported product in unified-docs system ## Key Issues Resolved - **Unversioned Documentation**: Configured `versionedDocs: false` for Packer in productConfig.mjs (unlike other products that use versioned structures) - **Content Structure**: Fixed nested directory issues (docs/docs) to match expected unified-docs format - **Redirects Format**: Converted Packer redirects from JS format to JSONC format required by unified-docs - **Port Conflicts**: Resolved Docker port binding conflicts during development - **Directory Structure**: Ensured proper content/packer/docs/ hierarchy vs versioned content/product/vX.X.X/ pattern ## Migration Summary Packer now fully integrated into unified-docs with proper unversioned documentation structure. The system handles Packer's non-versioned content correctly while maintaining compatibility with other versioned products in the platform.
1 parent 7bcbf90 commit cfe6b8b

File tree

420 files changed

+32524
-36
lines changed

Some content is hidden

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

420 files changed

+32524
-36
lines changed

content/packer/.github/CONTRIBUTING.md

Lines changed: 639 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
name: Bug Report
3+
about: You're experiencing an issue with Packer that is different from the documented behavior.
4+
labels: bug
5+
---
6+
7+
<!--- Please keep this note for the community --->
8+
9+
#### Community Note
10+
11+
* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
12+
* Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
13+
* If you are interested in working on this issue or have submitted a pull request, please leave a comment
14+
15+
<!--- Thank you for keeping this note for the community --->
16+
17+
When filing a bug, please include the following headings if possible. Any
18+
example text in this template can be deleted.
19+
20+
#### Overview of the Issue
21+
22+
A paragraph or two about the issue you're experiencing.
23+
24+
#### Reproduction Steps
25+
26+
Steps to reproduce this issue
27+
28+
### Packer version
29+
30+
From `packer version`
31+
32+
### Simplified Packer Template
33+
34+
If the file is longer than a few dozen lines, please include the URL to the
35+
[gist](https://gist.github.com/) of the log or use the [Github detailed
36+
format](https://gist.github.com/ericclemmons/b146fe5da72ca1f706b2ef72a20ac39d)
37+
instead of posting it directly in the issue.
38+
39+
### Operating system and Environment details
40+
41+
OS, Architecture, and any other information you can provide about the
42+
environment.
43+
44+
### Log Fragments and crash.log files
45+
46+
Include appropriate log fragments. If the log is longer than a few dozen lines,
47+
please include the URL to the [gist](https://gist.github.com/) of the log or
48+
use the [Github detailed format](https://gist.github.com/ericclemmons/b146fe5da72ca1f706b2ef72a20ac39d) instead of posting it directly in the issue.
49+
50+
Set the env var `PACKER_LOG=1` for maximum log detail.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Copyright (c) HashiCorp, Inc.
2+
# SPDX-License-Identifier: BUSL-1.1
3+
4+
blank_issues_enabled: false
5+
contact_links:
6+
- name: Packer Community Support
7+
url: https://discuss.hashicorp.com/c/packer/23
8+
about: If you have a question, or are looking for advice, please post on our Discuss forum! The community loves to chime in to help. Happy Coding!
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Feature Request
3+
about: If you have something you think Packer could improve or add support for.
4+
labels: enhancement
5+
---
6+
7+
<!--- Please keep this note for the community --->
8+
9+
#### Community Note
10+
11+
* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
12+
* Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
13+
* If you are interested in working on this issue or have submitted a pull request, please leave a comment
14+
15+
<!--- Thank you for keeping this note for the community --->
16+
17+
Please search the existing issues for relevant feature requests, and use the
18+
reaction feature
19+
(https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)
20+
to add upvotes to pre-existing requests.
21+
22+
#### Description
23+
24+
A written overview of the feature.
25+
26+
#### Use Case(s)
27+
28+
Any relevant use-cases that you see.
29+
30+
#### Potential configuration
31+
32+
```
33+
```
34+
35+
#### Potential References
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Plugin Integration Request
3+
about: Open request to add your plugin as a Packer integration (https://developer.hashicorp.com/packer/integrations)
4+
labels: integration-request
5+
---
6+
7+
#### Description
8+
9+
A written description of your plugin along with a link to the plugin repository.
10+
11+
#### Integration Tier
12+
<!--- By default all integrations are registered as community integrations.
13+
HashiCorp Technology partners https://www.hashicorp.com/partners/find-a-partner will be registered as a partner once verified. --->
14+
15+
#### Checklist
16+
- [ ] Has valid [`metadata.hcl`](https://github.com/hashicorp/integration-template) file in plugin repository.
17+
- [ ] Has added integration scripts [packer-plugin-scaffolding](https://github.com/hashicorp/packer-plugin-scoffolding) to plugin repository.
18+
- [ ] Has added top-level integration README.md file to plugin `docs` directory.
19+
- [ ] All plugins components have one README.md describing their usage.
20+
- [ ] Has a fully synced `.web-docs` directory ready for publishing to the integrations portal.
21+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Question
3+
about: If you have a question, please check out our other community resources instead of opening an issue.
4+
labels: question
5+
---
6+
7+
Issues on GitHub are intended to be related to bugs or feature requests, so we
8+
recommend using our other community resources instead of asking here if you
9+
have a question.
10+
11+
- Packer Guides: https://www.packer.io/guides
12+
- Discussion List: https://groups.google.com/group/packer-tool
13+
- Any other questions can be sent to the packer section of the HashiCorp
14+
forum: https://discuss.hashicorp.com/c/packer
15+
- Packer community links: https://www.packer.io/community
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: SSH or WinRM times out
3+
about: I have a waiting SSH or WinRM error.
4+
labels: communicator-question
5+
---
6+
7+
Got one of the following errors ? See if the related guides can help.
8+
9+
- `Waiting for WinRM to become available` ?
10+
11+
- See our basic WinRm Packer guide: https://www.packer.io/guides/automatic-operating-system-installs/autounattend_windows
12+
13+
- `Waiting for SSH to become available` ?
14+
15+
- See our basic SSH Packer guide: https://www.packer.io/guides/automatic-operating-system-installs/preseed_ubuntu
16+
17+
Issues on GitHub are intended to be related to bugs or feature requests, so we recommend using our other community resources instead of asking here if you have a question.
18+
19+
- Packer Guides: https://www.packer.io/guides
20+
- Discussion List: https://groups.google.com/group/packer-tool
21+
- Any other questions can be sent to the packer section of the HashiCorp
22+
forum: https://discuss.hashicorp.com/c/packer
23+
- Packer community links: https://www.packer.io/community
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
**DELETE THIS PART BEFORE SUBMITTING**
2+
3+
In order to have a good experience with our community, we recommend that you
4+
read the contributing guidelines for making a PR, and understand the lifecycle
5+
of a Packer Plugin PR:
6+
- https://github.com/hashicorp/$REPO_NAME/blob/main/.github/CONTRIBUTING.md#opening-an-pull-request
7+
8+
Please include tests. Check out these examples:
9+
10+
- https://github.com/hashicorp/packer/blob/master/builder/parallels/common/ssh_config_test.go#L34
11+
- https://github.com/hashicorp/packer/blob/master/post-processor/compress/post-processor_test.go#L153-L182
12+
13+
----
14+
15+
### Description
16+
What code changed, and why?
17+
18+
### Resolved Issues
19+
If your PR resolves any open issue(s), please indicate them like this so they
20+
will be closed when your PR is merged:
21+
Closes #xxx
22+
Closes #xxx
23+
24+
<!-- heimdall_github_prtemplate:grc-pci_dss-2024-01-05 -->
25+
### Rollback Plan
26+
If a change needs to be reverted, we will roll out an update to the code within
27+
7 days.
28+
29+
### Changes to Security Controls
30+
Are there any changes to security controls (access controls, encryption, logging)
31+
in this pull request? If so, explain.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: gomod
4+
directory: /
5+
schedule:
6+
interval: daily
7+
allow:
8+
- dependency-name: "github.com/hashicorp/packer-plugin-sdk"
9+
- dependency-name: "github.com/hashicorp/hcp-sdk-go"
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Copyright (c) HashiCorp, Inc.
2+
# SPDX-License-Identifier: BUSL-1.1
3+
4+
bug:
5+
- 'panic:'
6+
crash:
7+
- 'panic:'
8+

0 commit comments

Comments
 (0)