Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migration plugin docs to integration framework #328

Merged
merged 2 commits into from
Aug 24, 2023

Conversation

nywilken
Copy link
Contributor

@nywilken nywilken commented Aug 8, 2023

Add scaffolding for HashiCorp integrations

@nywilken nywilken requested a review from a team as a code owner August 8, 2023 17:33
Copy link
Contributor

@lbajolet-hashicorp lbajolet-hashicorp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@@ -35,3 +35,8 @@ generate: install-packer-sdc
packer-sdc renderdocs -src ./docs -dst ./.docs -partials ./docs-partials
# checkout the .docs folder for a preview of the docs

build-docs: install-packer-sdc
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we still leave the older generate task in place, should we only use build-docs after this PR is merged?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you're referring to the release pipeline. We are keeping everything the same until we've cut over the plugins to production. Once live we can remove the doc.zip generation. But it should not affect anything if left in place.

docs/README.md Outdated
source = "github.com/hashicorp/azure"
version = "~> 1"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that v2 is out, we could update this block to point to this version I would think

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated.

@nywilken nywilken added the documentation Improvements or additions to documentation label Aug 22, 2023
@nywilken nywilken closed this Aug 23, 2023
@nywilken nywilken reopened this Aug 23, 2023
@nywilken nywilken merged commit a9f8a4d into hashicorp:main Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants