This is an automated email from the ASF dual-hosted git repository.
sbp pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tooling-atr-experiments.git
commit cc49a3ad5b56b2df47e6a1de2db36d47616574aa
Author: Sean B. Palmer <s...@miscoranda.com>
AuthorDate: Wed Feb 12 14:29:16 2025 +0200
Add development documentation
---
Makefile | 7 ++++++-
README.md | 4 ++++
docs/development.html | 12 ++++++++++++
docs/development.md | 20 ++++++++++++++++++++
4 files changed, 42 insertions(+), 1 deletion(-)
diff --git a/Makefile b/Makefile
index 9d2aa52..2594e42 100644
--- a/Makefile
+++ b/Makefile
@@ -1,4 +1,4 @@
-.PHONY: build certs check report run sync
+.PHONY: build certs check docs report serve sync
MANAGER ?= poetry
PYTHON ?= /usr/bin/python3
@@ -13,6 +13,11 @@ certs:
check:
$(SCRIPTS)/run pre-commit run --all-files
+docs:
+ for fn in docs/*.md; \
+ do cmark "$$fn" > "$${fn%.md}.html"; \
+ done
+
report:
@echo SCRIPTS = $(SCRIPTS)
diff --git a/README.md b/README.md
index 277b0ba..d77c578 100644
--- a/README.md
+++ b/README.md
@@ -11,3 +11,7 @@ This experimental code is therefore published with no
guarantee of stability, se
## Purpose
This code is intended to one day help ASF Tooling to test internal ideas for
the [Apache Trusted
Release](https://github.com/apache/tooling-docs/blob/main/apache-trusted-release/requirements.md)
platform. In its early phase it consists only of, essentially, an empty Python
[asfquart](https://github.com/apache/infrastructure-asfquart) project.
+
+## License
+
+This project is licensed under the [Apache License 2.0](LICENSE).
diff --git a/docs/development.html b/docs/development.html
new file mode 100644
index 0000000..001ea0a
--- /dev/null
+++ b/docs/development.html
@@ -0,0 +1,12 @@
+<h1>Development</h1>
+<p>You will need to have a working <a
href="https://www.python.org/downloads/release/python-3132/";>Python 3.13</a>
installation, <a
href="https://python-poetry.org/docs/#installation";>Poetry</a>, and a POSIX
compliant <code>make</code>. To optionally build the HTML documentation files
you will also need <a href="https://github.com/commonmark/cmark";>cmark</a>.</p>
+<p>Ensure that you have the pre-commit hook installed:</p>
+<pre><code class="language-shell">make sync PYTHON="$(which python3)"
+poetry run pre-commit install
+</code></pre>
+<p>To run the project, use the following commands:</p>
+<pre><code class="language-shell">make sync PYTHON="$(which python3)"
+make certs
+make serve
+</code></pre>
+<p>The website will be available at <a
href="https://127.0.0.1:8080/";>https://127.0.0.1:8080/</a> using a self-signed
certificate.</p>
diff --git a/docs/development.md b/docs/development.md
new file mode 100644
index 0000000..b9338b2
--- /dev/null
+++ b/docs/development.md
@@ -0,0 +1,20 @@
+# Development
+
+You will need to have a working [Python
3.13](https://www.python.org/downloads/release/python-3132/) installation,
[Poetry](https://python-poetry.org/docs/#installation), and a POSIX compliant
`make`. To optionally build the HTML documentation files you will also need
[cmark](https://github.com/commonmark/cmark).
+
+Ensure that you have the pre-commit hook installed:
+
+```shell
+make sync PYTHON="$(which python3)"
+poetry run pre-commit install
+```
+
+To run the project, use the following commands:
+
+```shell
+make sync PYTHON="$(which python3)"
+make certs
+make serve
+```
+
+The website will be available at
[https://127.0.0.1:8080/](https://127.0.0.1:8080/) using a self-signed
certificate.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tooling.apache.org
For additional commands, e-mail: dev-h...@tooling.apache.org
