Skip to content

Commit

Permalink
Update docscheck.sh to accept provider function docs (hashicorp#17497) (
Browse files Browse the repository at this point in the history
hashicorp#17509)

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
  • Loading branch information
SarahFrench authored Mar 7, 2024
1 parent e8d5253 commit 816402c
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions scripts/docscheck.sh
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@ for doc in $docs; do
fi
;;

"functions")
# Functions require a page_title
grep "^page_title: " "$doc" > /dev/null
if [[ "$?" == "1" ]]; then
echo "Doc is missing a page_title: $doc"
error=true
fi
;;

*)
error=true
echo "Unknown category \"$category\". " \
Expand Down

0 comments on commit 816402c

Please sign in to comment.