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/03/24 20:05:41 UTC
[GitHub] [daffodil-site] stevedlawrence commented on a change in pull request #84: Add VSCode to Site
stevedlawrence commented on a change in pull request #84:
URL: https://github.com/apache/daffodil-site/pull/84#discussion_r834665355
##########
File path: site/_includes/themes/apache/_navigation.html
##########
@@ -4,6 +4,7 @@
<nav role="navigation">
<ul class="nav navbar-nav navbar-right">
<li><a href="/releases">Releases</a></li>
+ <li><a href="/vscode">VSCode</a></li>
Review comment:
I think we determined that the standard is "VS Code" with the space? Looks like everything in this PR used "VSCode". I don't really care, but we should try to be consistent.
##########
File path: site/_vscode/1.0.0.md
##########
@@ -0,0 +1,28 @@
+---
+
+released: true
+apache: true
+title: 1.0.0
Review comment:
We probably want the title to be something like "VS Code Extension 1.0.0". Otherwise the top of the page just says "1.0.0" and it's not clear it's for the extension.
##########
File path: site/_vscode/1.0.0.md
##########
@@ -0,0 +1,28 @@
+---
+
+released: true
+apache: true
+title: 1.0.0
+date: 2022-03-17
+summary: >
+ Initial release
+
+artifact-root: "https://dist.apache.org/repos/dist/dev/daffodil/daffodil-vscode/1.0.0-rc2/"
+checksum-root: "https://dist.apache.org/repos/dist/dev/daffodil/daffodil-vscode/1.0.0-rc2/"
+
+key-file: "https://downloads.apache.org/daffodil/KEYS"
+
+source-dist:
+ - "apache-daffodil-vscode-1.0.0-src.zip"
+
+binary-dist:
+ - "apache-daffodil-vscode-1.0.0.vsix"
+
+scala-version: 2.13
+---
+
+This release contains VSCode extension used parsing/debugging a daffodil schema inside of VSCode.
+
+#### v1.0.0
Review comment:
This v1.0.0 is redundant, that is at the top of the page. I think it can just be removed?
##########
File path: site/vscode.md
##########
@@ -0,0 +1,74 @@
+---
+layout: page
+title: VSCode Extension
+group: nav-right
+---
+<!--
+{% comment %}
+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.
+{% endcomment %}
+-->
+
+#### Summary
+This page is for the Daffodil VSCode Extension.
Review comment:
I'm not sure we need the #### Summary header or the line explain what this page is for. Instead, I think we should just explain what the VS Code extension is and it's capabilities. Imagine someone has no idea what it is, they click "VS Code" at the top and want to learn about it. That's the kind of information we want to add here. I think this assume too much existing knowledge.
##########
File path: site/_vscode/1.0.0.md
##########
@@ -0,0 +1,28 @@
+---
+
+released: true
+apache: true
+title: 1.0.0
+date: 2022-03-17
+summary: >
+ Initial release
+
+artifact-root: "https://dist.apache.org/repos/dist/dev/daffodil/daffodil-vscode/1.0.0-rc2/"
+checksum-root: "https://dist.apache.org/repos/dist/dev/daffodil/daffodil-vscode/1.0.0-rc2/"
+
+key-file: "https://downloads.apache.org/daffodil/KEYS"
+
+source-dist:
+ - "apache-daffodil-vscode-1.0.0-src.zip"
+
+binary-dist:
+ - "apache-daffodil-vscode-1.0.0.vsix"
+
+scala-version: 2.13
Review comment:
Scala-version isn't needed, that's only needed by the normal release thing for auto generating the maven pom stuff. This isn't distributed via maven, so isn't needed and can be removed.
##########
File path: site/_vscode/1.0.0.md
##########
@@ -0,0 +1,28 @@
+---
+
+released: true
+apache: true
+title: 1.0.0
+date: 2022-03-17
+summary: >
+ Initial release
+
+artifact-root: "https://dist.apache.org/repos/dist/dev/daffodil/daffodil-vscode/1.0.0-rc2/"
+checksum-root: "https://dist.apache.org/repos/dist/dev/daffodil/daffodil-vscode/1.0.0-rc2/"
+
+key-file: "https://downloads.apache.org/daffodil/KEYS"
+
+source-dist:
+ - "apache-daffodil-vscode-1.0.0-src.zip"
+
+binary-dist:
+ - "apache-daffodil-vscode-1.0.0.vsix"
+
+scala-version: 2.13
+---
+
+This release contains VSCode extension used parsing/debugging a daffodil schema inside of VSCode.
+
+#### v1.0.0
+
+[GitHub v1.0.0 Closed Issues](https://github.com/apache/daffodil-vscode/issues?q=is%3Aissue+is%3Aclosed)
Review comment:
This link is to all closed issues, not just those that were closed in 1.0.0. We probably want to label all closed issues with a 1.0.0 milestone and link to just the closed issues for that milestone, or just link to that milestone?
These notes are pretty sparse. Maybe that's just because this is the initial release? For daffodil we creates links to all bugs fixed, and write up details for the more interesting issues and how that affects users. One example, maybe we highlight the bug about adding the wizard and explain how the wizard can be used to generate debug configurations.
We definitely aren't required to do the same thing as daffodil, but it is sometimes useful to have more user friendly detailed release notes, at least for the more interesting changes.
##########
File path: site/vscode.md
##########
@@ -0,0 +1,74 @@
+---
+layout: page
+title: VSCode Extension
+group: nav-right
+---
+<!--
+{% comment %}
+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.
+{% endcomment %}
+-->
+
+#### Summary
+This page is for the Daffodil VSCode Extension.
+
+Features:
+
+* DFDL schema parsing/debugging
+* Output infoset to console, file or none
+* Session launch configuration
+* Scala implementation of the daffodil debugger
+* View infoset while debugging
+* View difference of infoset from one step to another when debugging
+* View hex of the data file
+* Launch wizard, helps create the `.vscode/launch.json`
+* Run currently opened schema file
+* Debug currently opened schema file
+* Daffodil toolbar and Command Palette:
+ * Open infoset view
+ * Open infoset diff view
+ * Open hex view
+ * Open launch wizard
+* Set breakpoints inside of main schema file
+* Set breakpoints inside of imported schemas
Review comment:
This is a good example of things that might be good information in the 1.0.0 page. This is a listing of all new features added in the release. Adding extra details about some of these could make for a nice set of release notes.
--
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