02e037eb0e
## Description - Removed link to the Corso website - Whitespace cleanups - Removed unused images - Added publish steps for docs (now the website) - Deletes unused favicon images - Fixes blog typos (Closes #1553) - Removed unused logos - Removed cloud backup image duplication - Removed unused video - Added missing image to a blog post - Deleted unused blog post images - Remove unused page that pollutes the sitemap ## Type of change <!--- Please check the type of change your PR introduces: ---> - [x] 🗺️ Documentation
70 lines
2.4 KiB
Makefile
70 lines
2.4 KiB
Makefile
.PHONY: buildimage build dev shell check genclidocs _validatemdgen publish sync
|
|
|
|
CORSO_BUILD_DIR := /tmp/.corsobuild
|
|
CORSO_BUILD_CACHE := ${CORSO_BUILD_DIR}/cache
|
|
CORSO_BUILD_MOD := ${CORSO_BUILD_DIR}/mod
|
|
CORSO_BUILD_BIN := ${CORSO_BUILD_DIR}/bin
|
|
CORSO_REPO := /go/src/github.com/alcionai/corso
|
|
CORSO_LOCAL_PATH := $(shell git rev-parse --show-toplevel)
|
|
GIT_SHA := $(shell git rev-parse --short HEAD)
|
|
DOCSC := docker run --rm -it -p 3000:3000 -v ${PWD}:/usr/src/docs --env CORSO_VERSION=unreleased-${GIT_SHA} corso/docs
|
|
CBASE := docker run --rm -it \
|
|
-v ${CORSO_LOCAL_PATH}:${CORSO_REPO} -v ${CORSO_BUILD_DIR}:${CORSO_BUILD_DIR} \
|
|
--env GOCACHE=${CORSO_BUILD_CACHE} --env GOMODCACHE=${CORSO_BUILD_MOD} --env GOTMPDIR=${CORSO_BUILD_DIR} \
|
|
--workdir ${CORSO_REPO}/src
|
|
GOC := ${CBASE} golang:1.18
|
|
GOBASHC := ${CBASE} --entrypoint bash golang:1.18
|
|
MDGEN_SRC := ${CORSO_REPO}/src/cmd/mdgen/mdgen.go
|
|
MDGEN_BINARY := ${CORSO_BUILD_BIN}/mdgen
|
|
CLI_DOCS := ${CORSO_REPO}/docs/docs/cli
|
|
|
|
buildimage:
|
|
docker build -t "corso/docs:latest" .
|
|
|
|
dev: genclidocs
|
|
$(DOCSC) npm start -- --host 0.0.0.0
|
|
|
|
VALE_TARGET ?= docs README.md
|
|
|
|
check: genclidocs
|
|
$(DOCSC) vale $(VALE_TARGET)
|
|
$(DOCSC) markdownlint '**/*.md' --ignore styles/ --ignore src/ --ignore node_modules/
|
|
|
|
localcheck: genclidocs
|
|
vale $(VALE_TARGET)
|
|
markdownlint '**/*.md' --ignore styles/ --ignore src/ --ignore node_modules/
|
|
|
|
dockershell:
|
|
$(DOCSC) bash
|
|
|
|
build: genclidocs
|
|
$(DOCSC) npm run build
|
|
|
|
genclidocs: _validatemdgen ${MDGEN_BINARY}
|
|
@echo 'Auto-generating Corso CLI docs...'
|
|
$(DOCSC) rm -rf docs/cli
|
|
$(GOC) ${MDGEN_BINARY} --cli-folder ${CLI_DOCS}
|
|
|
|
_validatemdgen: # in case we have a different architecture
|
|
@echo 'Verifying dependencies...'
|
|
$(GOBASHC) -c "${MDGEN_BINARY} --help >/dev/null || rm -rf ${MDGEN_BINARY}"
|
|
|
|
${MDGEN_BINARY}: $(shell find ${CORSO_LOCAL_PATH}/src -type f -name *.go) $(shell find ${CORSO_LOCAL_PATH}/src -type d )
|
|
@echo 'Re-building Corso CLI docs auto-gen tooling...'
|
|
$(GOC) go mod download
|
|
$(GOC) go build -o ${MDGEN_BINARY} ${MDGEN_SRC}
|
|
|
|
clean:
|
|
$(DOCSC) rm -rf docs/cli build node_modules
|
|
$(GOC) rm -rf ${CORSO_BUILD_DIR}/*
|
|
|
|
publish: clean build
|
|
docker run -e AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY \
|
|
-e AWS_SESSION_TOKEN -e AWS_REGION \
|
|
--rm -v ${PWD}:/usr/src/docs corso/docs:latest \
|
|
make sync
|
|
|
|
sync:
|
|
aws s3 sync /usr/src/docs/build/ s3://corsobackup.io/ --exclude ".git/*" --delete
|
|
aws cloudfront create-invalidation --distribution-id E1W9NGI9YTVZ1A --paths "/*"
|