From 103dcfd9a2fc8e786710df9f818d2eae34281d05 Mon Sep 17 00:00:00 2001 From: Christian Nunciato Date: Mon, 20 May 2024 10:04:51 -0700 Subject: [PATCH] Add frequent/copyable commands to the README (#11864) --- README.md | 10 +++++++++- scripts/serve.sh | 2 +- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a8f0609feaab..d43b3f83ab31 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,14 @@ The `Makefile` exposes a number of useful helpers for authoring: * `make new-blog-post` scaffolds a new, bare-bones blog post with placeholder content * `make new-example-program` generates a new multi-language set of examples at `./static/programs` +As a content contributor, the commands you'll most often use are these: + +```bash +make ensure # Install or update dependencies. +make serve # Run the development server locally on http://localhost:1313. +make lint # Identify any Markdown or code-formatting issues so you an fix them. +``` + ## Generating SDK and CLI documentation We generate two kinds of reference documentation with this repository: language-specific SDK docs (for a subset of Pulumi packages) and CLI docs (for command-line tools like `pulumi` and `esc`). Instructions for generating both types of docs are listed below. @@ -125,7 +133,7 @@ pulumi gen-markdown ./content/docs/cli/commands # Generate Pulumi CLI documen esc gen-docs ./content/docs/esc-cli/commands # Generate Pulumi ESC CLI documentation. ``` -Generated docs reflect the functionality of the currently installed CLI, so make sure you've installed the latest public version of each one ([`pulumi`](https://github.com/pulumi/pulumi/releases), [`esc`](https://github.com/pulumi/esc/releases)) before running these commands and submitting your PR. +Generated docs reflect the functionality of the currently installed CLI, so make sure you've installed the latest public version of each one ([`pulumi`](https://github.com/pulumi/pulumi/releases), [`esc`](https://github.com/pulumi/esc/releases)) before running these commands and submitting your PR. ### Viewing rendered SDK and CLI docs locally diff --git a/scripts/serve.sh b/scripts/serve.sh index c11c644f3238..6563cf8cd68e 100755 --- a/scripts/serve.sh +++ b/scripts/serve.sh @@ -19,4 +19,4 @@ export REL_JS_BUNDLE="/js/bundle.min.${ASSET_BUNDLE_ID}.js" # URL to the Pulumi conversion service. export PULUMI_CONVERT_URL="${PULUMI_CONVERT_URL:-$(pulumi stack output --stack pulumi/tf2pulumi-service/production url)}" -hugo server --buildDrafts --buildFuture \ No newline at end of file +HUGO_BASEURL=http://localhost:1313 hugo server --buildDrafts --buildFuture