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

Update registry publishing guidance #628

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

deniseyu
Copy link

@deniseyu deniseyu commented May 3, 2024

All HashiCorp-maintained providers will soon distributed the repository's license file with their artifacts. This PR adds similar instructions for community-maintained providers if maintainers are interested in doing the same

What

Adds new text to website/docs/registry/providers/publishing.mdx.

Why

HashiCorp's partners and community members may be interested in distributing their project's license alongside the release artifact.

Screenshots


Merge Checklist

If items do not apply to your changes, add (N/A) and mark them as complete.

Pull Request

  • One or more labels describe the type of change (e.g. clarification) and associated product (e.g. HCP Terraform ).
  • Description links to related pull requests or issues, if any.

Content

  • Redirects have been added to website/redirects.js for moved, renamed, or deleted pages.
  • API documentation and the API Changelog have been updated.
  • Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
  • Pages with related content are updated and link to this content when appropriate.
  • Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
  • New pages have metadata (page name and description) at the top.
  • 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.
  • New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
  • UI elements (button names, page names, etc.) are bolded.
  • The Vercel website preview successfully deployed.

Reviews

  • I or someone else reviewed the content for technical accuracy.
  • I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

All HashiCorp-maintained providers will soon distributed the repository's license file with their artifacts. This PR adds similar instructions for community-maintained providers if maintainers are interested in doing the same
Copy link

vercel bot commented May 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
terraform-docs-common ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 3, 2024 7:59pm

@bflad
Copy link
Contributor

bflad commented May 6, 2024

@deniseyu I wouldn't be opposed to updating terraform-provider-scaffolding-framework's .goreleaser.yml for this change since its safe for anyone and then not needing this here 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants