From 0d6f1d47478ad4defac43dd24148682f188432aa Mon Sep 17 00:00:00 2001 From: William Sandner Date: Sat, 25 Mar 2023 12:16:07 +0100 Subject: [PATCH] Fix linter issues --- .vscode/settings.json | 4 +--- Feature-Format.md | 6 +++--- License.md | 9 +++++---- Use-Case-Format.md | 14 ++++++++------ Words-of-Wisdom.md | 24 +++++++++++++----------- Workflows.md | 5 +++-- 6 files changed, 33 insertions(+), 29 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 36d5450..b59c95d 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,5 +1,3 @@ { - "markdownlint.config": { - "MD026": { "punctuation": "?" } - } + "markdownlint.config": {} } \ No newline at end of file diff --git a/Feature-Format.md b/Feature-Format.md index 6117946..ee86e1f 100644 --- a/Feature-Format.md +++ b/Feature-Format.md @@ -42,7 +42,7 @@ Description: Precise Details: -- ::LOGICAL CONSTRAINT +- ::LOGICAL CONSTRAINT - ::LOGICAL CONSTRAINT Notes and Questions: @@ -79,6 +79,6 @@ Notes and Questions: For more information on advice, see: -- Words of wisdom on [feature sets](http://readyset.tigris.org/words-of-wisdom/feature-set.html). +- Words of wisdom on [feature sets](https://web.archive.org/web/20200701142616/http://readyset.tigris.org/words-of-wisdom/feature-set.html). -- Words of wisdom on [feature specifications](http://readyset.tigris.org/words-of-wisdom/features.html). +- Words of wisdom on [feature specifications](https://web.archive.org/web/20200701142616/http://readyset.tigris.org/words-of-wisdom/features.html). diff --git a/License.md b/License.md index 417553e..6be8c1a 100644 --- a/License.md +++ b/License.md @@ -1,4 +1,5 @@ + Do not modify or delete this file. This file describes the license under which you may use the ReadySET templates. @@ -33,8 +34,8 @@ POSSIBILITY OF SUCH DAMAGE. Yes, absolutely. Once you fill in the template with detailed information about a specific project, you are free to do what you -want with them in the context of that project. ***You may even hide the -template copyright statement***: the best way to do that is to edit the +want with them in the context of that project. **_You may even hide the +template copyright statement_**: the best way to do that is to edit the file inst.css. #### Can I modify these templates for use on several projects at my company? @@ -47,7 +48,7 @@ copyright statement clearly visible in each file. If you use the templates and fill in details about a given product, go ahead. If you are thinking of making a product that includes the -templates for use *as templates*, you must retain this file and the +templates for use _as templates_, you must retain this file and the copyright statement in a visible footnote. An enhanced commercial version of these templates, [ReadySETPro](http://www.readysetpro.com/), is already in development @@ -63,7 +64,7 @@ same license. No, but it would be very welcome. Even if you don't modify the templates, you can share your "words of wisdom". For more information on contributing, see the -[ReadySET home page](http://readyset.tigris.org/). +[ReadySET home page](https://web.archive.org/web/20200701142616/http://readyset.tigris.org/). #### ReadySET seems too good to be true. What is the catch? Why would anyone buy a commercial version? diff --git a/Use-Case-Format.md b/Use-Case-Format.md index c4294f7..335a531 100644 --- a/Use-Case-Format.md +++ b/Use-Case-Format.md @@ -1,4 +1,5 @@ + ##### Related Documents - [SRS](SRS) > [Use Case Suite](Use-Case-Suite) > Use Case Format @@ -10,9 +11,9 @@ cases and gives tips on writing use cases. You can copy and paste the sample use case into your [Use Cases](Use-Cases) document. This file itself should not be edited to hold specific use cases. -*TODO: Use this template once in your [Use Cases](Use-Cases) +_TODO: Use this template once in your [Use Cases](Use-Cases) document. Anything you mention here will apply to all use cases in that -file.* +file._ --- @@ -31,9 +32,9 @@ file.* **Prerequisite:** ::Project is set up -*TODO: Copy and paste this use case template as many times as needed in +_TODO: Copy and paste this use case template as many times as needed in your [Use Cases](Use-Cases) document. Only use those fields that -are not the same as the default for all use cases.* +are not the same as the default for all use cases._ --- @@ -74,6 +75,7 @@ are not the same as the default for all use cases.* **Alternative Scenario Extensions:** - ::If CONDITION, then ALTERNATIVE STEPS. + - ::NOTES or DETAILS. - ::If CONDITION, then ALTERNATIVE STEPS. @@ -140,5 +142,5 @@ use case. For more information on advice, see: -- Words of wisdom on [use case suites](http://readyset.tigris.org/words-of-wisdom/use-case-suite.html). -- Words of wisdom on [use cases](http://readyset.tigris.org/words-of-wisdom/use-cases.html). +- Words of wisdom on [use case suites](https://web.archive.org/web/20200701142616/http://readyset.tigris.org/words-of-wisdom/use-case-suite.html). +- Words of wisdom on [use cases](https://web.archive.org/web/20200701142616/http://readyset.tigris.org/words-of-wisdom/use-cases.html). diff --git a/Words-of-Wisdom.md b/Words-of-Wisdom.md index ce64885..93e48c6 100644 --- a/Words-of-Wisdom.md +++ b/Words-of-Wisdom.md @@ -1,4 +1,4 @@ -# Template List +# Words of Wisdom The original [ReadySET Pro](http://readysetpro.com) words of wisdom are [here](http://www.readysetpro.com/words-of-wisdom). @@ -6,7 +6,9 @@ The original [ReadySET Pro](http://readysetpro.com) words of wisdom are [here](h The following pages contain specific tips and advice on each template. -## Project kick-off +## Development Documents + +### Project kick-off * [Project proposal](Words-of-Wisdom-Proposal) * [Target audience & benefits](Words-of-Wisdom-Target-and-Benefits) @@ -14,26 +16,26 @@ The following pages contain specific tips and advice on each template. * [Interview notes](Words-of-Wisdom-Interview-Notes) * [All-in-one project summary](Words-of-Wisdom-All-in-One-Project-Summary) -## Project Reference Information +### Project Reference Information * [Project overview](Words-of-Wisdom-Project-Overview) * [Glossary / Data dictionary](Words-of-Wisdom-Glossary-and-Data-Dictionary) * [Software development method](Words-of-Wisdom-Software-Development-Method) -## System requirements +### System requirements * [SRS](Words-of-Wisdom-SRS) * [Use case suite](Words-of-Wisdom-Use-Case-Suite) * [Feature set](Words-of-Wisdom-Feature-Set) -## Planning +### Planning * [Project plan](Words-of-Wisdom-Project-Plan) * [Resource needs](Words-of-Wisdom-Resource-Needs) * [Risk management](Words-of-Wisdom-Risk-Management) * [Legal issues](Words-of-Wisdom-Legal-Issues) -## Design +### Design * [Design overview](Words-of-Wisdom-Design-Overview) * [Architecture](Words-of-Wisdom-Architecture) @@ -42,29 +44,29 @@ The following pages contain specific tips and advice on each template. * [Security](Words-of-Wisdom-Security) * [Source organization](Words-of-Wisdom-Source-Organization) -## Project tracking +### Project tracking * [Status report](Words-of-Wisdom-Status-Report) * [Review meeting](Words-of-Wisdom-Review-Meeting) -## Quality management +### Quality management * [QA plan](Words-of-Wisdom-QA-Plan) * [Test suite](Words-of-Wisdom-Test-Suite) -## Product content +### Product content * [Release notes](Words-of-Wisdom-Release-Notes) * [Installation / Quick-start](Words-of-Wisdom-Installation-and-Quick-Start) * [User Guide](Words-of-Wisdom-User-Guide) * [FAQ / Troubleshooting](Words-of-Wisdom-FAQ-and-Troubleshooting) -## Product support information +### Product support information * [Implementation notes](Words-of-Wisdom-Implementation-Notes) * [Demo script](Words-of-Wisdom-Demo-Script) -## Release end-game +### Release end-game * [Release checklist](Words-of-Wisdom-Release-Checklist) * [Postmortem report](Words-of-Wisdom-Postmortem-Report) diff --git a/Workflows.md b/Workflows.md index c69ca39..5ddb660 100644 --- a/Workflows.md +++ b/Workflows.md @@ -1,4 +1,5 @@ + ### By Activity 1. Project Planning @@ -122,7 +123,7 @@ ### How to download these templates -- [Download template archive](http://readyset.tigris.org/servlets/ProjectDocumentList), or -- Use CVS to [check out](http://readyset.tigris.org/servlets/ProjectSource) project +- [Download template archive](https://web.archive.org/web/20200701142616/http://readyset.tigris.org/servlets/ProjectDocumentList), or +- Use CVS to [check out](https://web.archive.org/web/20200701142616/http://readyset.tigris.org/servlets/ProjectSource) project "readyset" or clone from [ReadySet GFM](https://github.com/bike-bill/readyset-gfm/wiki) on Github.