Skip to content

docs(providers): Enhance front matter documentation #335

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.

Sign up for GitHub

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

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

docs(providers): Enhance front matter documentation #335

wants to merge 1 commit into from

Conversation

djetelina
Copy link

Checklist

  • I have read the contribution guide.
  • I have not used an AI coding assistant to create this PR.
  • My contribution is compatible with the MPL-2.0 license and I have provided a DCO sign-off on all my commits.
  • I have written all code in this PR myself OR I have marked all code I have not written myself (including modified code, e.g. copied from other places and then modified) with a comment indicating where it came from.

@djetelina djetelina requested a review from a team as a code owner June 9, 2025 16:06
@djetelina
Copy link
Author

I forced push prettier-formatted document so that the check would pass.

Yantrio
Yantrio reviewed Jun 10, 2025
View reviewed changes
frontend/docs/providers/docs.md Outdated

Title of the registry UI webpage (and some meta tags).

!> Terraform registry also uses page_title to replace the text of the resource in the sidebar, which can be very useful for guides. However OpenTofu registry UI currently doesn't show page title in the sidebar
Copy link
Member

Choose a reason for hiding this comment

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

I don't think we need to discuss the terraform registry here. If you feel that this difference is important then I would love it if you could open an issue so we can discuss how you feel it should work! we're open to options!

Copy link
Author

Choose a reason for hiding this comment

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

I did think about this quite a bit and couldn't figure out a better way to note down the difference that felt important for developers already used to the registry 'feature' that the meta tag was intended for.

If you think the difference isn't noteworthy, I can delete this note.

Either way I raised the issue here: #336

Copy link
Member

Choose a reason for hiding this comment

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

I think its not needed here, would you mind removing it and then we can discuss more in #336 :) Thanks!

Copy link
Author

Choose a reason for hiding this comment

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

Removed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Yantrio Yantrio Yantrio approved these changes

@yottta yottta yottta approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@djetelina @Yantrio @yottta