Skip to content

Commit

Permalink
build: preview docs locally (#470)
Browse files Browse the repository at this point in the history 
Signed-off-by: Kostis Kapelonis <kostis@codefresh.io>

Signed-off-by: Kostis Kapelonis <kostis@codefresh.io>
  • Loading branch information
@kostis-codefresh
kostis-codefresh committed Nov 16, 2022
1 parent cd59074 commit 33d18dd
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
10 changes: 10 additions & 0 deletions Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ override LDFLAGS += \
-X ${VERSION_PACKAGE}.gitCommit=${GIT_COMMIT} \
-X ${VERSION_PACKAGE}.buildDate=${BUILD_DATE}


MKDOCS_DOCKER_IMAGE?=squidfunk/mkdocs-material:4.1.1
MKDOCS_RUN_ARGS?=


.PHONY: all
all: prereq controller

Expand Down Expand Up @@ -137,3 +142,8 @@ run-test:
--kubeconfig /kube/config \
--argocd-server-addr $(ARGOCD_SERVER) \
--grpc-web


.PHONY: serve-docs
serve-docs:
docker run ${MKDOCS_RUN_ARGS} --rm -it -p 8000:8000 -v ${CURRENT_DIR}:/docs ${MKDOCS_DOCKER_IMAGE} serve -a 0.0.0.0:8000
2 changes: 2 additions & 0 deletions docs/contributing/development.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ important targets are:
* `manifests` - this will build the installation manifests for Kubernetes from
the Kustomize sources

* `serve-docs` will render the documentation at localhost:8000 (requires Docker)

### Windows Developer Tips

If you are running the cmd shell and are running into issues running `make all`, consider using Git bash.
Expand Down

1 comment on commit 33d18dd

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@check-spelling-bot Report

🔴 Please review

See the 📜action log for details.

Unrecognized words (1)

localhost

Previously acknowledged words that are now absent mypass myuser otherapp wildcard wohoo
To accept ✔️ these unrecognized words as correct and remove the previously acknowledged and now absent words, run the following commands

... in a clone of the git@github.com:argoproj-labs/argocd-image-updater.git repository
on the master branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/prerelease/apply.pl' |
perl - 'https://github.com/argoproj-labs/argocd-image-updater/actions/runs/3476160302/attempts/1'
Available 📚 dictionaries could cover words not in the 📘 dictionary

This includes both expected items (26) from .github/actions/spelling/expect.txt and unrecognized words (1)

Dictionary Entries Covers
cspell:cpp/src/cpp.txt 30216 5
cspell:software-terms/src/software-terms.txt 1237 3
cspell:python/src/python/python-lib.txt 3873 2
cspell:typescript/typescript.txt 1211 1
cspell:node/node.txt 1768 1

Consider adding them using (in .github/workflows/spelling.yml):

      with:
        extra_dictionaries:
          cspell:cpp/src/cpp.txt
          cspell:software-terms/src/software-terms.txt
          cspell:python/src/python/python-lib.txt
          cspell:typescript/typescript.txt
          cspell:node/node.txt

To stop checking additional dictionaries, add:

      with:
        check_extra_dictionaries: ''

Please sign in to comment.