You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@daffodil.apache.org by GitBox <gi...@apache.org> on 2022/12/09 14:09:21 UTC

[GitHub] [daffodil-vscode] scholarsmate opened a new pull request, #381: Generate portable documentation from the wiki

scholarsmate opened a new pull request, #381:
URL: https://github.com/apache/daffodil-vscode/pull/381

   This PR uses `pandoc` and `make` to generate portable `.docx` documents using the project wiki as the source material.
   
   closes #380


-- 
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

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

Posted by GitBox <gi...@apache.org>.
scholarsmate commented on code in PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#discussion_r1044887452


##########
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:
   `pandoc` can do PDF, but it had problems with the 📝 glyph, yet I can export as `PDF` from `Word` just fine.
   
   ```shell
   ✗ pandoc -f markdown -o Apache-Daffodil™-Extension-for-Visual-Studio-Code.pdf .wiki/Apache-Daffodil™-Extension-for-Visual-Studio-Code.md
   Error producing PDF.
   ! LaTeX Error: Unicode character 📝 (U+1F4DD)
                  not set up for use with LaTeX.
   
   See the LaTeX manual or LaTeX Companion for explanation.
   Type  H <return>  for immediate help.
    ...
   
   l.274 📝
   ```
   



-- 
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

[GitHub] [daffodil-vscode] mbeckerle commented on pull request #381: Generate portable documentation from the wiki

Posted by GitBox <gi...@apache.org>.
mbeckerle commented on PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#issuecomment-1344723719

   Maybe this new doc should be run by us and published on the daffodil site as part of each release? Then people could just download it. 


-- 
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

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

Posted by GitBox <gi...@apache.org>.
stevedlawrence commented on PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#issuecomment-1359875484

   > So what should be done is I add pandoc to the release-canidate container, then update the process to create the Makefile, clone the repo and make the docs?
   
   Yep. You might not even need the Makefile? Just need to update the release-candidate script to run the couple of commands that are needed. It's just a git clone and pandoc, right?
   
   > After making the docs how would I upload them to the daffodil-site or would I upload somewhere similar to where the bin and source are stored?
   
   The release candidate script already clones and updates the site repo with java/scala docs, so it should be similar. For example, it currenly does this:
   
   ```
       echo "Installing Site Docs..."
       rm -rf $DAFFODIL_DOCS_DIR
       mkdir -p $DAFFODIL_DOCS_DIR/{javadoc,scaladoc}/
       cp -R target/javaunidoc/* $DAFFODIL_DOCS_DIR/javadoc/
       cp -R target/scala-2.12/unidoc/* $DAFFODIL_DOCS_DIR/scaladoc/
   ```
   Note ha DAFFODIL_DOCS_DIR is just subdirecory in DAFFODIL_SITE_DIR specific to java/scaladocs.
   
   So in the "daffodil-vscode" section of the container scrip, you can clone the vscode wiki, run pandoc, and copy the resulting file somewhere to $DAFFODIL_SITE_DIR.
   
   Whatever changes you make to the site repo are automatically committed and pushed when "complete-release" is run, so it's just a matter of building and installing the resulting pdf's to the right directory in the site repo and everything else should just work.


-- 
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

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

Posted by 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

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

Posted by GitBox <gi...@apache.org>.
stevedlawrence commented on PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#issuecomment-1359901639

   Yep, seems reasonable to me


-- 
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

[GitHub] [daffodil-vscode] Shanedell closed pull request #381: Generate portable documentation from the wiki

Posted by GitBox <gi...@apache.org>.
Shanedell closed pull request #381: Generate portable documentation from the wiki
URL: https://github.com/apache/daffodil-vscode/pull/381


-- 
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

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

Posted by GitBox <gi...@apache.org>.
scholarsmate commented on code in PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#discussion_r1044893893


##########
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've had this Makefile in my repo for a couple of weeks and it has indeed been of use when sharing and collaborating on the documentation via SharePoint.  I get that it's yet _another_ build tool and possibly someone can rewrite the Makefile targets in `yarn` or `sbt`.



-- 
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

[GitHub] [daffodil-vscode] Shanedell commented on pull request #381: Generate portable documentation from the wiki

Posted by GitBox <gi...@apache.org>.
Shanedell commented on PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#issuecomment-1359892179

   @stevedlawrence That makes sense thank you. Should I make a directory `site/docs/vscode/{release_version}` to hold the docs? Currently it seems the base directories are mapped to daffodil release so figured we want a separate folder for the vscode releases correct?


-- 
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

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

Posted by GitBox <gi...@apache.org>.
scholarsmate commented on code in PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#discussion_r1044896595


##########
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:
   I put this in there for consistency in that I've added it to the top of the wiki pages so that when generating documentation, it appears at the top of the stand-alone document, it looks nice and adds a little bit of extra polish.  This `README.md` probably won't ever need to be turned into a portable document, so the point may be moot, but I still think it looks nice.



-- 
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

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

Posted by GitBox <gi...@apache.org>.
stevedlawrence commented on PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#issuecomment-1344725898

   > Maybe this new doc should be run by us and published on the daffodil site as part of each release? Then people could just download it.
   
   It wouldn't be too hard to add the git checkout + pandoc commands to the release candidate container script and add the result to the site repo. Similar to what we already do for Daffodil lib java/scala docs. This way we never even need to manually run it and it's just part of the automated process.


-- 
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

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

Posted by GitBox <gi...@apache.org>.
scholarsmate commented on code in PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#discussion_r1044893893


##########
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've had this Makefile in my repo for a couple of weeks and it has indeed been of use when sharing and collaborating on the documentation via SharePoint.  I get that it's yet _another_ build tool and possibly someone can rewrite the Makefile targets, in a cross-platform way (as done here), in `yarn` or `sbt`.



-- 
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

[GitHub] [daffodil-vscode] Shanedell commented on pull request #381: Generate portable documentation from the wiki

Posted by GitBox <gi...@apache.org>.
Shanedell commented on PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#issuecomment-1346927759

   > Maybe this new doc should be run by us and published on the daffodil site as part of each release? Then people could just download it.
   
   @mbeckerle +1 👍, I think the `daffodil-site` repo would be a better location for this to live.


-- 
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

[GitHub] [daffodil-vscode] Shanedell commented on pull request #381: Generate portable documentation from the wiki

Posted by GitBox <gi...@apache.org>.
Shanedell commented on PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#issuecomment-1369909172

   I am going to be closing this PR as these PR's replace it:
   
   - https://github.com/apache/daffodil-site/pull/103
   - https://github.com/apache/daffodil/pull/897
   


-- 
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

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

Posted by GitBox <gi...@apache.org>.
mbeckerle commented on code in PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#discussion_r1046135958


##########
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:
   That character U+1F4DD is in the Unicode supplemental characters area which is for chars with codes above U+FFFF, which are often not supported by Java-based software, or anything that assumes a wchar is 2 bytes.
   There is also often no font support in many fonts, etc.
   
   It takes 2 16-bit code units to represent that character in a Java string or any other system with 16-bit code units for strings. It takes 4 bytes in UTF-8. 
   
   Maybe the easiest thing would be to just use a Unicode character with codepoint below U+FFFF. There are plenty of useful symbolic glyphs without having to reach into the suppmental unicode chars. 



-- 
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

[GitHub] [daffodil-vscode] scholarsmate commented on pull request #381: Generate portable documentation from the wiki

Posted by GitBox <gi...@apache.org>.
scholarsmate commented on PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#issuecomment-1344852345

   @stevedlawrence and @mbeckerle, I really like the idea of publishing the documentation via a release script and allowing users to just download the built artifacts.  This also solves the problem where the documents move along with the releases.  We'll want to publish the documentation as points in time.  For instance documentation for v1.2.0 will be different than v1.3.0, etc.  Since the wiki itself is a git repo, we can tag it, but if we have the documents generated at the time of a release, it solves the problem that way.


-- 
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

[GitHub] [daffodil-vscode] Shanedell commented on pull request #381: Generate portable documentation from the wiki

Posted by GitBox <gi...@apache.org>.
Shanedell commented on PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#issuecomment-1352471181

   > > @mbeckerle +1 👍, I think the `daffodil-site` repo would be a better location for this to live.
   > 
   > @Shanedell, will take point on making that happen?
   
   Yeah I should be able to get this going tomorrow


-- 
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

[GitHub] [daffodil-vscode] scholarsmate commented on pull request #381: Generate portable documentation from the wiki

Posted by GitBox <gi...@apache.org>.
scholarsmate commented on PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#issuecomment-1352469054

   > @mbeckerle +1 👍, I think the `daffodil-site` repo would be a better location for this to live.
   
   @Shanedell, will take point on making that happen?


-- 
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

[GitHub] [daffodil-vscode] Shanedell commented on pull request #381: Generate portable documentation from the wiki

Posted by GitBox <gi...@apache.org>.
Shanedell commented on PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#issuecomment-1359748443

   @stevedlawrence @mbeckerle I think I miss understood. So what should be done is I add `pandoc` to the release-canidate container, then update the process to create the Makefile, clone the repo and make the docs? After making the docs how would I upload them to the daffodil-site or would I upload somewhere similar to where the bin and source are stored?


-- 
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

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

Posted by GitBox <gi...@apache.org>.
scholarsmate commented on code in PR #381:
URL: https://github.com/apache/daffodil-vscode/pull/381#discussion_r1044893893


##########
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've had this Makefile in my repo for a couple of weeks and it has indeed been of use when sharing and collaborating on the documentation via SharePoint.  I get that it's yet _another_ build tool and possibly someone can rewrite the Makefile targets in a, cross-platform way, in `yarn` or `sbt`.



-- 
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