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 docscheck.sh to accept provider function docs #17497

Merged
merged 1 commit into from
Mar 7, 2024

Conversation

SarahFrench
Copy link
Member

@SarahFrench SarahFrench commented Mar 6, 2024

(This docscheck.sh script is a good candidate for being replaced with official tools, but for now updating this script to avoid false alarms about bad docs)

After merging this PR I'll cherry pick the commit from main into the feature branch.


Manual test without this edit to docscheck.sh:

  • If I add the file website/docs/functions/example.html.markdown with example docs content from here to the TPG repo
  • and then run make docscheck
  • I see:
terraform-provider-google % make docscheck
Unknown category "functions".  Docs can only exist in r/, d/, or guides/ folders.
make: *** [docscheck] Error 1

Manual test with this PR's edit to docscheck.sh:

  • Given a repo with the new file described above
  • If I update the script as per this PR and then run make docscheck I see no output:
terraform-provider-google % make docscheck

This script is a good candidate for being replaced with official tools, but for now updating this script to avoid false alarms about bad docs
Copy link

github-actions bot commented Mar 6, 2024

** WARNING **: This repository is generated by https://github.com/GoogleCloudPlatform/magic-modules. Any changes made directly to this repository will likely be overwritten. If you have further questions, please feel free to ping your reviewer or, internal employees, reach out to one of the engineers. Thank you!

@SarahFrench
Copy link
Member Author

I'm going to proceed without review/approval as I've tested the change above and the strategy for these PRs was already discussed here: #17465 (comment)

@SarahFrench SarahFrench merged commit b1f6df2 into main Mar 7, 2024
6 checks passed
SarahFrench added a commit that referenced this pull request Mar 7, 2024
This script is a good candidate for being replaced with official tools, but for now updating this script to avoid false alarms about bad docs
SarahFrench added a commit that referenced this pull request Mar 7, 2024
This script is a good candidate for being replaced with official tools, but for now updating this script to avoid false alarms about bad docs
@SarahFrench SarahFrench deleted the SarahFrench-update-docscheck-script-main branch March 22, 2024 21:32
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant