[GitHub] [daffodil-vscode] stevedlawrence commented on a diff in pull request #381: Generate portable documentation from the wiki

[GitBox <gi...@apache.org>]

stevedlawrence commented on code in PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#discussion_r1044499165


##########
docs/Makefile:
##########
@@ -0,0 +1,34 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+SRCDIR := .wiki/
+DOCX = $(addsuffix .docx,$(basename $(notdir $(wildcard $(SRCDIR)*.md))))
+
+$(SRCDIR):
+	git clone https://github.com/apache/daffodil-vscode.wiki.git .wiki
+
+%.docx:
+	pandoc -t docx -f markdown -o $@ $(addprefix $(SRCDIR),$(addsuffix .md,$(basename $@)))
+
+update: $(SRCDIR)
+	cd $<; git pull
+
+all: update
+	${MAKE} $(DOCX)
+
+clean:
+	rm -rf *.docx $(SRCDIR)
+
+.PHONY: update all clean

Review Comment:
   I'm not a huge fan of adding yet a another build tool requirement of `make` (we already have `sbt` and `yarn`), but I guess since this is just for documentation it's not a big deal.
   
   Another alternative would be to just to add script/directions in the root of the wiki repo, and anyone that wants to generate documentation could clone the wiki repo and run the command. Seems a bit odd to me to have that in this repo.
   
   Could even have a page on the wiki with the instructions instead (e.g. clone the wiki repo, install pandoc, run this pandoc command).
   
   But I won't stand in the way if others like the idea of having it in this repo.



##########
docs/Makefile:
##########
@@ -0,0 +1,34 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+SRCDIR := .wiki/
+DOCX = $(addsuffix .docx,$(basename $(notdir $(wildcard $(SRCDIR)*.md))))
+
+$(SRCDIR):
+	git clone https://github.com/apache/daffodil-vscode.wiki.git .wiki
+
+%.docx:
+	pandoc -t docx -f markdown -o $@ $(addprefix $(SRCDIR),$(addsuffix .md,$(basename $@)))

Review Comment:
   Seems a pdf might be more useful? Or maybe add a pdf build target to support both?



##########
docs/README.md:
##########
@@ -0,0 +1,46 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<div align="center">
+
+<img src="https://daffodil.apache.org/assets/themes/apache/img/apache-daffodil-logo.png" height="85" alt="Apache Daffodil"/>

Review Comment:
   Should we remove the logo and divs? Seems that's really just a thing for the main README.md. 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org