vbatts/ntfy
1
0
Fork 0
Code Pull requests Activity

WIP: Develop docs

Browse source
This commit is contained in:
Philipp Heckel 2022-03-16 22:33:23 -04:00
parent 470d11f442
commit 5b10f51af1
2 changed files with 97 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

60
Makefile
View file

@ -4,37 +4,47 @@ VERSION := $(shell git describe --tag)
help:
@echo "Typical commands:"
@echo " make check - Run all tests, vetting/formatting checks and linters"
@echo " make fmt build-snapshot install - Build latest and install to local system"
@echo " make check - Run all tests, vetting/formatting checks and linters"
@echo " make build-snapshot install - Build latest and install to local system"
@echo
@echo "Test/check:"
@echo " make test - Run tests"
@echo " make race - Run tests with -race flag"
@echo " make coverage - Run tests and show coverage"
@echo " make coverage-html - Run tests and show coverage (as HTML)"
@echo " make coverage-upload - Upload coverage results to codecov.io"
@echo " make test - Run tests"
@echo " make race - Run tests with -race flag"
@echo " make coverage - Run tests and show coverage"
@echo " make coverage-html - Run tests and show coverage (as HTML)"
@echo " make coverage-upload - Upload coverage results to codecov.io"
@echo
@echo "Lint/format:"
@echo " make fmt - Run 'go fmt'"
@echo " make fmt-check - Run 'go fmt', but don't change anything"
@echo " make vet - Run 'go vet'"
@echo " make lint - Run 'golint'"
@echo " make staticcheck - Run 'staticcheck'"
@echo " make fmt - Run 'go fmt'"
@echo " make fmt-check - Run 'go fmt', but don't change anything"
@echo " make vet - Run 'go vet'"
@echo " make lint - Run 'golint'"
@echo " make staticcheck - Run 'staticcheck'"
@echo
@echo "Build:"
@echo " make build - Build"
@echo " make build-snapshot - Build snapshot"
@echo " make build-simple - Build (using go build, without goreleaser)"
@echo " make clean - Clean build folder"
@echo "Build main client/server:"
@echo " make build - Build (using goreleaser, requires clean repo)"
@echo " make build-snapshot - Build snapshot (using goreleaser, dirty repo)"
@echo " make build-simple - Quick & dirty build (using go build, without goreleaser)"
@echo " make clean - Clean build folder"
@echo
@echo "Build web app:"
@echo " make web - Build the web app"
@echo " make web-deps - Install web app dependencies (npm install the universe)"
@echo " make web-build - Actually build the web app"
@echo
@echo "Build documentation:"
@echo " make docs - Build the documentation"
@echo " make docs-deps - Install Python dependencies (pip3 install)"
@echo " make docs-build - Actually build the documentation"
@echo
@echo "Releasing (requires goreleaser):"
@echo " make release - Create a release"
@echo " make release-snapshot - Create a test release"
@echo " make release - Create a release"
@echo " make release-snapshot - Create a test release"
@echo
@echo "Install locally (requires sudo):"
@echo " make install - Copy binary from dist/ to /usr/bin"
@echo " make install-deb - Install .deb from dist/"
@echo " make install-lint - Install golint"
@echo " make install - Copy binary from dist/ to /usr/bin"
@echo " make install-deb - Install .deb from dist/"
@echo " make install-lint - Install golint"
# Documentation
@ -42,9 +52,11 @@ help:
docs-deps: .PHONY
pip3 install -r requirements.txt
docs: docs-deps
docs-build: .PHONY
mkdocs build
docs: docs-deps docs-build
# Web app
@ -126,7 +138,7 @@ build: build-deps
build-snapshot: build-deps
goreleaser build --snapshot --rm-dist --debug
build-simple: clean
build-simple: .PHONY
mkdir -p dist/ntfy_linux_amd64 server/docs server/site
touch server/docs/index.html
touch server/site/app.html