doc: Fix readme, Makefile

benolayinka · benolayinka · commit c8a8dbfee3f0 · 2020-09-29T12:24:08.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -104,3 +104,6 @@ $RECYCLE.BIN/
 *.lnk
 
 # End of https://www.toptal.com/developers/gitignore/api/hugo,go,macos,windows,linux
+
+### Internal docs build
+/internal/
diff --git a/Makefile b/Makefile
@@ -17,38 +17,43 @@ HUGO = $(GO) run -tags extended github.com/gohugoio/hugo
 YARN_DEPS = doc/themes/the-things-stack/node_modules
 FREQUENCY_PLAN_URL = https://raw.githubusercontent.com/TheThingsNetwork/lorawan-frequency-plans/master/frequency-plans.yml
 FREQUENCY_PLAN_DEST = doc/data/frequency-plans.yml
-PUBLIC_DEST = public
-INTERNAL_DEST = internal
+DOC_ROOT = doc
+PUBLIC_DEST = ../public # Relative to DOC_ROOT
+INTERNAL_DEST = ../internal # Relative to DOC_ROOT
 ENVIRONMENT = gh-pages
+HUGO_BASE_URL = thethingsindustries.com/docs
 
 .PHONY: default
-default: build.internal
+default: server
 
 .PHONY: clean.internal
 clean.internal:
-	rm -rf $(INTERNAL_DEST)
+	cd $(DOC_ROOT) && rm -rf $(INTERNAL_DEST)
 
 .PHONY: clean.public
 clean.public:
-	rm -rf $(PUBLIC_DEST)
+	cd $(DOC_ROOT) && rm -rf $(PUBLIC_DEST)
+
+.PHONY: clean.deps
+clean.deps:
+	rm -rf $(FREQUENCY_PLAN_DEST)
 
 .PHONY: build.internal
-build.internal: $(INTERNAL_DEST) deps
-	$(HUGO) -d $(INTERNAL_DEST)
+build.internal: deps
+	$(HUGO) --source $(DOC_ROOT) --destination $(INTERNAL_DEST)
 
 .PHONY: build.public
-build.public: $(PUBLIC_DEST) deps
-	$(HUGO) -s "./doc" -d $(PUBLIC_DEST) -b $(HUGO_BASE_URL) --environment $(ENVIRONMENT)
+build.public: deps
+	$(HUGO) --source $(DOC_ROOT) --destination $(PUBLIC_DEST) --baseURL $(HUGO_BASE_URL) --environment $(ENVIRONMENT)
 
 .PHONY: server
 server: deps
-	$(HUGO) server -s "./doc" --environment $(ENVIRONMENT)
+	$(HUGO) server -s $(DOC_ROOT) --environment $(ENVIRONMENT)
 
 .PHONY: deps
-deps: frequency-plan-deps | $(YARN_DEPS)
+deps: $(FREQUENCY_PLAN_DEST) | $(YARN_DEPS)
 
-.PHONY: frequency-plan-deps
-frequency-plan-deps:
+$(FREQUENCY_PLAN_DEST):
 	curl -o $(FREQUENCY_PLAN_DEST) $(FREQUENCY_PLAN_URL)
 
 $(YARN_DEPS):
diff --git a/README.md b/README.md
@@ -18,16 +18,16 @@ In order to build the documentation site with the right theme, you need to run
 ## Running a Development Server
 
 You can start a development server with live reloading by running
-`make server`. This command will print the address of the server.
+`make` or `make server`. This command will print the address of the server.
 
 ## Building the Documentation for Github Pages
 
-The documentation site can be built for Github Pages by running `make build-public`. This will
+The documentation site can be built for Github Pages by running `make build.public`. This will
 output the site to `public`.
 
 ## Building the Documentation for Internal (Offline) Use
 
-The documentation site can be built for internal (offline) use by running `make build` or `make build-internal`. This will
+The documentation site can be built for internal (offline) use by running `make build.internal`. This will
 output the site to `internal`.
 
 ## Style Guidelines
diff --git a/doc/.gitignore b/doc/.gitignore
@@ -1,5 +1,2 @@
-/ttn-lw-*/ttn-lw-*.md
-/ttn-lw-*/ttn-lw-*.yaml
-/ttn-lw-*/ttn-lw-*.1
 /resources
 /public
