Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include EX-CommandStation Release Notes on website #460

Draft
wants to merge 2 commits into
base: sphinx
Choose a base branch
from

Conversation

cjmayo
Copy link
Contributor

@cjmayo cjmayo commented Oct 29, 2022

Add CommandStation-EX as a Git submodule and then symlink its
Release_Notes directory.


release_notes

Needs some consideration:

For the developer:

  • adds a new Python dependency, myst_parser
  • to stop any build warnings would now need to have a copy of CommandStation-EX within dcc-ex.github.io clone (a bit of developer documentation to add for git submodule init; git submodule update)

GitHub workflow will fail due to warnings here, needs the following CommandStation-EX changes:

--- a/Release_Notes/ThrottleAssists.md
+++ b/Release_Notes/ThrottleAssists.md
@@ -1,4 +1,8 @@
-Throttle Assist updates for versiuon 4.?
+---
+orphan: true
+---
+
+# Throttle Assist updates for versiuon 4.?
 
 Chris Harlow April 2022
 
--- /dev/null
+++ b/Release_Notes/index.rst
@@ -0,0 +1,9 @@
+*******************************
+Release Notes
+*******************************
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+    
+    release_notes*
--- a/Release_Notes/release_notes_v3.0.0.md
+++ b/Release_Notes/release_notes_v3.0.0.md
@@ -1,10 +1,11 @@
-
+# Version 3.0 Release Notes
 
 The DCC-EX Team is pleased to release CommandStation-EX-v3.0.0 as a Production Release.  This release is a major re-write of earlier versions.  We've re-architected the code-base so that it can better handle new features going forward.  Download the compressed files here:
 
 **Downloads (zip and tar.gz) below. These are named without version number in the folder name to make the Arduino IDE happy.**
 
 [CommandStation-EX.zip](https://github.com/DCC-EX/CommandStation-EX/files/5611333/CommandStation-EX.zip)
+
 [CommandStation-EX.tar.gz](https://github.com/DCC-EX/CommandStation-EX/files/5611335/CommandStation-EX.tar.gz)
 
 
@@ -81,5 +82,5 @@ The DCC-EX Team is pleased to release CommandStation-EX-v3.0.0 as a Production R
 **Downloads (zip and tar.gz) below. These are named without version number in the folder name to make the Arduino IDE happy.**
 
 [CommandStation-EX.zip](https://github.com/DCC-EX/CommandStation-EX/files/5611333/CommandStation-EX.zip)
-[CommandStation-EX.tar.gz](https://github.com/DCC-EX/CommandStation-EX/files/5611335/CommandStation-EX.tar.gz)
 
+[CommandStation-EX.tar.gz](https://github.com/DCC-EX/CommandStation-EX/files/5611335/CommandStation-EX.tar.gz)
--- a/Release_Notes/release_notes_v3.1.0.md
+++ b/Release_Notes/release_notes_v3.1.0.md
@@ -1,8 +1,11 @@
+# Version 3.1.0 Release Notes
+
 The DCC-EX Team is pleased to release CommandStation-EX-v3.1.0 as a Production Release.  Release v3.1.0 is a minor release that adds additional features and fixes a number of bugs. With the number of new features, this could have easily been a major release. The team is continually improving the architecture of DCC++EX to make it more flexible and optimizing the code so as to get more performance from the Arduino (and other) microprocessors.  This release includes all of the Point Releases from v3.0.1 to v3.0.16.
 
 **Downloads (zip and tar.gz) below. These are named without version number in the folder name to make the Arduino IDE happy.**
 
 [CommandStation-EX.zip](https://github.com/DCC-EX/CommandStation-EX/releases/download/v3.1.0-Prod/CommandStation-EX.zip)
+
 [CommandStation-EX.tar.gz](https://github.com/DCC-EX/CommandStation-EX/releases/download/v3.1.0-Prod/CommandStation-EX.tar.gz)
 
 **Known Issues**
@@ -10,7 +13,7 @@ The DCC-EX Team is pleased to release CommandStation-EX-v3.1.0 as a Production R
 - **Wi-Fi** - works, but requires sending <AT> commands from a serial monitor if you want to switch between AP mode and STA station mode after initial setup
 - **Pololu Motor Shield** - is supported with this release, but the user may have to adjust timings to enable programming mode due to limitation in its current sensing circuitry
 
-#### Summary of key features and/or bug fixes by Point Release
+## Summary of key features and/or bug fixes by Point Release
 
 **Summary of the key new features added to CommandStation-EX V3.0.16**
 
@@ -203,4 +206,5 @@ The DCC-EX Team is pleased to release CommandStation-EX-v3.1.0 as a Production R
 **Downloads (zip and tar.gz) below. These are named without version number in the folder name to make the Arduino IDE happy.**
 
 [CommandStation-EX.zip](https://github.com/DCC-EX/CommandStation-EX/releases/download/v3.1.0-Prod/CommandStation-EX.zip)
+
 [CommandStation-EX.tar.gz](https://github.com/DCC-EX/CommandStation-EX/releases/download/v3.1.0-Prod/CommandStation-EX.tar.gz)
--- a/Release_Notes/release_notes_v4.0.0.md
+++ b/Release_Notes/release_notes_v4.0.0.md
@@ -1,5 +1,5 @@
 Version 4.0 Release Notes
-*************************
+=========================
 
 The DCC-EX Team is pleased to release CommandStation-EX-v4.0.0 as a Production Release.  Release v4.0.0 is a Major release that adds significant new product design, plus Automation features and bug fixes. The team continues improving the architecture of DCC++EX to make it more flexible and optimizing the code so as to get more performance from the Arduino (and other) microprocessors.  This release includes all of the Point Releases from v3.2.0 to v3.2.0 rc13.
 
@@ -84,7 +84,7 @@ The DCC-EX Team is pleased to release CommandStation-EX-v4.0.0 as a Production R
 - Common Fault Pin Error
 - Uno Memory Utilization optimized
 
-#### Summary of Release 3.1.0 key features and/or bug fixes by Point Release
+## Summary of Release 3.1.0 key features and/or bug fixes by Point Release
 
 **Summary of the key new features added to CommandStation-EX V3.0.16**
 
--- a/Release_Notes/release_notes_v4.1.1.md
+++ b/Release_Notes/release_notes_v4.1.1.md
@@ -1,5 +1,5 @@
 Version 4.1.1 Release Notes
-*************************
+===========================
 
 The DCC-EX Team is pleased to release CommandStation-EX v4.1.1 as a Production Release for the general public.
 This release is a Minor release with many significant EX-RAIL enhancements and new automation features in addition to some bug fixes. 
@@ -136,7 +136,7 @@ See the version.h file for notes about which of the 4.1.1 features were added/ch
 - Common Fault Pin Error
 - Uno Memory Utilization optimized
 
-#### Summary of Release 3.1.0 key features and/or bug fixes by Point Release
+## Summary of Release 3.1.0 key features and/or bug fixes by Point Release
 
 **Summary of the key new features added to CommandStation-EX V3.0.16**
 
--- a/Release_Notes/release_notes_v4.1.2.md
+++ b/Release_Notes/release_notes_v4.1.2.md
@@ -1,5 +1,5 @@
 Version 4.1.2 Release Notes
-*************************
+===========================
 
 The DCC-EX Team is pleased to release CommandStation-EX v4.1.2 as a Production Release for the general public.
 This release is a Bugfix release which fixes support for Ethernet Shields based on the W5100 chip that broke with the release of v4.1.1. This chip does not report HW and link status the way the W5200 and W5500 do, so the check routine needed to be changed.
@@ -139,7 +139,7 @@ See the version.h file for notes about which of the 4.1.2 features were added/ch
 - Common Fault Pin Error
 - Uno Memory Utilization optimized
 
-#### Summary of Release 3.1.0 key features and/or bug fixes by Point Release
+## Summary of Release 3.1.0 key features and/or bug fixes by Point Release
 
 **Summary of the key new features added to CommandStation-EX V3.0.16**
 

Add CommandStation-EX as a Git submodule and then symlink its
Release_Notes directory.
@github-actions github-actions bot added the Documentation Item relates to documentation label Oct 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Item relates to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant