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/20 18:53:29 UTC
[GitHub] [daffodil] stevedlawrence commented on a diff in pull request #897: Update release-candidate to install VS Code Extension docs.
stevedlawrence commented on code in PR #897:
URL: https://github.com/apache/daffodil/pull/897#discussion_r1053643145
##########
containers/release-candidate/src/daffodil-release-candidate:
##########
@@ -300,6 +301,23 @@ case $PROJECT_REPO in
yarn package
cp *.vsix $DAFFODIL_RELEASE_DIR/bin/
+ echo "Building Extension Docs..."
+ git clone https://github.com/apache/daffodil-vscode.wiki.git .wiki
+ for markdown_file in $(echo "\
+ Apache-Daffodil™-Extension-for-Visual-Studio-Code \
+ Apache-Daffodil™-Extension-for-Visual-Studio-Code:-Development \
+ Apache-Daffodil™-Extension-for-Visual-Studio-Code:-Roadmap \
+ Home"
+ ); do
+ pandoc -t html -f markdown -o "${markdown_file}.html" ".wiki/${markdown_file}.md"
+ done
+ rm -rf .wiki
+
+ echo "Installing Extension Docs..."
+ rm -rf $DAFFODIL_VSCODE_DOCS_DIR
+ mkdir -p $DAFFODIL_VSCODE_DOCS_DIR
+ cp -R *.html $DAFFODIL_VSCODE_DOCS_DIR
+
Review Comment:
Below under "Committing Site Changes", we have a line that looks like this:
```
git diff-index --quiet HEAD || git commit -m "Stage release v$VERSION-$PRE_RELEASE"
```
Since this now could commit something for daffodil or daffodil vscode, I suggest we change it to this:
```
git diff-index --quiet HEAD || git commit -m "Stage $PROJECT_NAME release v$VERSION-$PRE_RELEASE"
```
##########
containers/release-candidate/src/daffodil-release-candidate:
##########
@@ -300,6 +301,23 @@ case $PROJECT_REPO in
yarn package
cp *.vsix $DAFFODIL_RELEASE_DIR/bin/
+ echo "Building Extension Docs..."
+ git clone https://github.com/apache/daffodil-vscode.wiki.git .wiki
+ for markdown_file in $(echo "\
+ Apache-Daffodil™-Extension-for-Visual-Studio-Code \
+ Apache-Daffodil™-Extension-for-Visual-Studio-Code:-Development \
+ Apache-Daffodil™-Extension-for-Visual-Studio-Code:-Roadmap \
+ Home"
+ ); do
+ pandoc -t html -f markdown -o "${markdown_file}.html" ".wiki/${markdown_file}.md"
Review Comment:
I thought the original goal was to have a single PDF easily downloadable for offline documentation? But this just creates multiple html pages, which I think are really just snapshot of the wiki. And the fomatting isn't as nice. For example, the github pages have a navigation menu on he right of each page, and the images are scaled to fit.
So I guess my question is how important is this snapshotting of wiki documentation? Seems to me most of the time people will always be using the latest version of the extension and go to the github wiki. It feels different from the Daffodil JAPI/SAPI where often times upgrading to a new version really does incur a cost so people do need API docs of older versions. And Java/Scala docs also aren't easily available since they need to be generated, unlike the github wiki.
##########
containers/release-candidate/src/daffodil-release-candidate:
##########
@@ -300,6 +301,23 @@ case $PROJECT_REPO in
yarn package
cp *.vsix $DAFFODIL_RELEASE_DIR/bin/
+ echo "Building Extension Docs..."
+ git clone https://github.com/apache/daffodil-vscode.wiki.git .wiki
+ for markdown_file in $(echo "\
+ Apache-Daffodil™-Extension-for-Visual-Studio-Code \
+ Apache-Daffodil™-Extension-for-Visual-Studio-Code:-Development \
+ Apache-Daffodil™-Extension-for-Visual-Studio-Code:-Roadmap \
+ Home"
Review Comment:
Can we automate getting the list of files? Seems it would be difficult to remember to update this script every time a new wiki page is created
##########
containers/release-candidate/src/daffodil-release-candidate:
##########
@@ -300,6 +301,23 @@ case $PROJECT_REPO in
yarn package
cp *.vsix $DAFFODIL_RELEASE_DIR/bin/
+ echo "Building Extension Docs..."
+ git clone https://github.com/apache/daffodil-vscode.wiki.git .wiki
+ for markdown_file in $(echo "\
+ Apache-Daffodil™-Extension-for-Visual-Studio-Code \
+ Apache-Daffodil™-Extension-for-Visual-Studio-Code:-Development \
+ Apache-Daffodil™-Extension-for-Visual-Studio-Code:-Roadmap \
+ Home"
+ ); do
+ pandoc -t html -f markdown -o "${markdown_file}.html" ".wiki/${markdown_file}.md"
+ done
+ rm -rf .wiki
+
+ echo "Installing Extension Docs..."
+ rm -rf $DAFFODIL_VSCODE_DOCS_DIR
+ mkdir -p $DAFFODIL_VSCODE_DOCS_DIR
+ cp -R *.html $DAFFODIL_VSCODE_DOCS_DIR
Review Comment:
Would it be possible to generate the *.html files in a different directory, or maybe in the .wiki directocy? I could imagine someday we might add a an .html file to the root of the daffodil-vscode repo and it shouldn't be copied to the docs directory.
--
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