From ede5eec5144048e420a265ac5baecc4ea29ff27c Mon Sep 17 00:00:00 2001 From: Vi Grey Date: Mon, 26 Sep 2022 04:02:25 -0500 Subject: Change RFC file locations and add CONTRIBUTING.md Add `latest/` and `tasd-spec-{version}/` directories to `docs/` Add "contribution" rule in `Makefile` to automate the process of adding updated documents to the `docs/` directory Add "Keep a Changelog" link and sentence to this `CHANGELOG.md` file Add Initial `CONTRIBUTING.md` file Rename `draft-tasd-{version}` to `draft-tasd-spec-{version}` Clean up documents rule in `Makefile` to avoid using `cd` and `mv` --- Makefile | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) (limited to 'Makefile') diff --git a/Makefile b/Makefile index 8028f64..3446b2c 100644 --- a/Makefile +++ b/Makefile @@ -23,15 +23,23 @@ # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF # SUCH DAMAGE. -DOC_NAME := draft-tasd-0001 +DOC_NAME := draft-tasd-spec-0001 +DOC_NAME_NO_VERSION := draft-tasd-spec CURRENTDIR := $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) documents: - mkdir -p $(CURRENTDIR)build/docs; \ - cd $(CURRENTDIR)src/docs; \ - xml2rfc $(DOC_NAME).xml --text --html --pdf --no-external-js --no-external-css --v3 --id-is-work-in-progress --no-pagination; \ - mv $(DOC_NAME).pdf $(DOC_NAME).html $(DOC_NAME).txt $(CURRENTDIR)build/docs; \ - cd $(CURRENTDIR); \ + mkdir -p $(CURRENTDIR)build/docs + xml2rfc $(CURRENTDIR)src/docs/$(DOC_NAME).xml -p $(CURRENTDIR)build/docs --text --html --pdf --no-external-js --no-external-css --v3 --id-is-work-in-progress --no-pagination + +contribution: + mkdir -p $(CURRENTDIR)docs/$(DOC_NAME) + mkdir -p $(CURRENTDIR)docs/latest + cp $(CURRENTDIR)build/docs/$(DOC_NAME).txt $(CURRENTDIR)docs/$(DOC_NAME)/ + cp $(CURRENTDIR)build/docs/$(DOC_NAME).html $(CURRENTDIR)docs/$(DOC_NAME)/ + cp $(CURRENTDIR)build/docs/$(DOC_NAME).pdf $(CURRENTDIR)docs/$(DOC_NAME)/ + cp $(CURRENTDIR)build/docs/$(DOC_NAME).txt $(CURRENTDIR)docs/latest/$(DOC_NAME_NO_VERSION).txt + cp $(CURRENTDIR)build/docs/$(DOC_NAME).html $(CURRENTDIR)docs/latest/$(DOC_NAME_NO_VERSION).html + cp $(CURRENTDIR)build/docs/$(DOC_NAME).pdf $(CURRENTDIR)docs/latest/$(DOC_NAME_NO_VERSION).pdf clean: - rm -rf -- $(CURRENTDIR)build; \ + rm -rf -- $(CURRENTDIR)build -- cgit v1.2.3