Instructions to generate API docs have a few hiccups

[thoward]

Problem description

Following the instructions in README.md to generate API docs, I ran into a couple small issues.

First, Typedoc needs to be installed, and while it's mentioned that it is used in the dependencies section, it doesn't state that it needs to be installed. That's a minor nit.

Later, the ./scripts/run_typedoc.sh seems to require sudo while generating cloud API docs.

Example: Error output

$ ./scripts/run_typedoc.sh
[..snip..]
yarn run tsc
yarn run v1.22.22
$ /Users/thoward/workspace/github/pulumi/pulumi-cloud/api/node_modules/.bin/tsc
✨  Done in 1.04s.
sed -e "s/\${VERSION}/v0.40.2/g" < package.json > bin/package.json
cp ../README.md ../LICENSE bin/
INSTALL:
mkdir: /opt/pulumi: Permission denied
make: *** [install] Error 1

but running via sudo gets past that issue.

But then while generating docs for the terraform repo we run into the need for pulumictl, in the which is also not mentioned in the requirements section. It's unclear if this missing dependency is a breaking issue or not because despite the errors it exits successfully. Will have to look at the output to see if the generate docs are correct or not when pulumictl is not present. I installed it anyway and was able to get a non-error run but haven't compared the output between the two.

Example: pulumictl requirement error

terraform
Generating pulumi.com API docs
~/workspace/github/pulumi/pulumi-terraform ~/workspace/github/pulumi/docs
make: pulumictl: Command not found
make: pulumictl: Command not found
make: pulumictl: Command not found
make: pulumictl: Command not found
make: *** No rule to make target `ensure'.  Stop.
[info] Loaded plugin typedoc-plugin-script-inject
[warning] PostgresRemoteStateReferenceArgs, defined in ./state/pgBackendConfig.ts, is referenced by state.RemoteStateReferenceArgs but not included in the documentation.
[info] Documentation generated at /Users/thoward/workspace/github/pulumi/docs/static-prebuilt/docs/reference/pkg/nodejs/pulumi/terraform
~/workspace/github/pulumi/docs

installing the pulumictl tool gives this output:

terraform
Generating pulumi.com API docs
~/workspace/github/pulumi/pulumi-terraform ~/workspace/github/pulumi/docs
make: *** No rule to make target `ensure'.  Stop.
[info] Loaded plugin typedoc-plugin-script-inject
[warning] PostgresRemoteStateReferenceArgs, defined in ./state/pgBackendConfig.ts, is referenced by state.RemoteStateReferenceArgs but not included in the documentation.
[info] Documentation generated at /Users/thoward/workspace/github/pulumi/docs/static-prebuilt/docs/reference/pkg/nodejs/pulumi/terraform
~/workspace/github/pulumi/docs

Done

Suggestions for a fix

Update the documentation to mention the additional requirements.