fix(docs): exclude README.mdx from docs.zip - Githubissues

UpCloudLtd / packer-plugin-upcloud

A suite of Packer plugins for provisioning UpCloud servers

https://github.com/UpCloudLtd/packer-plugin-upcloud

MIT License

4 stars 7 forks source link

fix(docs): exclude README.mdx from docs.zip #26

Closed peknur closed 2 years ago

peknur commented 2 years ago

Changes

exclude docs/README.mdx from docs.zip and rename docs/builder to docs/builders so that zip's content is compatible with Hashicorp website
change example directory link to point GH repository

Test docs.zip locally

in packer-plugin-upcloud repository checkout fix/docs-zip branch
run make ci-release-docs - this will create docs.zip in the project root dir
clone Packer repositorygit clone https://github.com/hashicorp/packer.git
copy docs.zip from UpCloud plugin repo into website folder

append following JSON object to website/data/plugins-manifest.json:

{
"title": "UpCloud",
"path": "upcloud",
"repo": "hashicorp/packer-plugin-upcloud",
"version": "latest",
"sourceBranch": "master",
"zipFile": "/website/docs.zip"
}

start dev server using Docker cd website && make (more info https://github.com/hashicorp/packer/tree/master/website#running-the-site-locally)
open http://127.0.0.1:3000/plugins