-
Notifications
You must be signed in to change notification settings - Fork 90
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
Fixes for How to Improve Testing for CSE Software article #2141
Fixes for How to Improve Testing for CSE Software article #2141
Conversation
I noticed the messed up formatting when I saw this article on bssw.io. (I did not realize that this howto article got converted over to bssw.io. Not sure what I did not at least review that article at the time.) Each sentence is now on its own line.
This is consistent with the other copied over article "Definition and Categorization of Tests for CSE Software" that listed the full set of original authors.
I also put in links to references that we have CC articles for
This runs wikize-refs.py but it creates an off-by one error. I will fix that in the next commit manually.
Now the links are correct. It was easy to fix.
* More informative deck text * Define CSE * Add "uncovered" for LSCA stuff * Change from "push" to "merge" to recognised the modern way to do testing with modern CI testing systems like GitHub Actions and GitLab CI
Here is the generated article: The multi-level numbering is unfortunate in that it does not change the numbering style for the nested lists. For example, GitHub formats this with 1, 2, 3 ... for the first level and i, ii, iii, ... for the second level as: but the bssw.io site generator just uses 1, 2, 3, .... for every level like: That is unfortunate. This does not look very good. It seems the alterative is to use manual HTML list formatting as described at: Is it worthwhile trying that? But this still looks way better than the current production article at: which has formatting completely messed up, for example showing: |
This is a lot of manual HTML formatting which included having to: * Switch to HTML formatting for bold and italics * Manually put in <a href="..."> links to the references (which does not support the tool-tip). Not so much markup anymore, but let's see what the bssw.io site generator does with this.
So, I created the commit 79c2a21 that tries to take over the formatting with HTML and the bssw.io site generator ignores the And I know that this is the new version as of that command because the "view source" link on Chrome for that page shows:
and there is the So that was a waste of time. But at least we now know that resistance is futile and we can just acquiesce the to borg bssw.io site generator and live with what we are given😊 (But it would be nice to address #1469 and #706.) |
This reverts commit 79c2a21. This did not improve the display of the generated page on preview.bssw.io :-(
This is ready to merge. Since this is a big improvement over the current production article, I will just merge it and rebuild the production site. |
20af21b
into
betterscientificsoftware:main
We see the updated article deployed at: and it looks quite a lot better, IMHO. |
See commits for details.