Suborbital-Systems/ReadySetGit
2
0
Fork 0
Code Pull Requests Packages Projects Releases Activity

Add experimental links

Browse Source
This commit is contained in:
William Sandner 2021-08-01 13:41:38 +02:00
parent e391771066
commit 245376ef2d
10 changed files with 27 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Demo-Script.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)

1
Design-Architecture.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::PROJECT-NAME(Home) ::PROJECT-NAME(Home)

3
Design-Components.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::PROJECT-NAME ::PROJECT-NAME
@ -51,7 +52,7 @@ made from other documents, issues, and email messages.*
### C-01: COMPONENT NAME ### C-01: COMPONENT NAME
**Description:** **Description:**
::DESCRIPTION ::DESCRIPTION
**Environmental Constraints:** **Environmental Constraints:**

5
Design-Persistence.md
View File

@ -1,10 +1,14 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::PROJECT-NAME ::PROJECT-NAME
##### Internal Release Number ##### Internal Release Number
::X.Y.Z ::X.Y.Z
##### Related Documents ##### Related Documents
- [Design](Design) > Design Persistence - [Design](Design) > Design Persistence
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -17,6 +21,7 @@
features. Some example text is provided. Add or delete text as needed.* features. Some example text is provided. Add or delete text as needed.*
#### What are the most important facts that a developer should know about persistent data storage in this system? #### What are the most important facts that a developer should know about persistent data storage in this system?
::PARAGRAPH OR BULLETS ::PARAGRAPH OR BULLETS
#### What are the ranked goals for persistence in this system? #### What are the ranked goals for persistence in this system?

3
Design-Scalability.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::PROJECT-NAME ::PROJECT-NAME
@ -49,5 +50,5 @@ How well do these mechanisms support the achievement of your goals?
::Yes, everyone understands. Feedback is welcome. ::Yes, everyone understands. Feedback is welcome.
::No, this is a risk that is noted in the ::No, this is a risk that is noted in the
[Risk Management](Project-Plan#Risk-Management) section. [Risk Management](Project-Plan#Risk-Management) section.

15
Design-Src-Org.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::PROJECT-NAME ::PROJECT-NAME
@ -70,19 +71,19 @@ overall structure or build process.*
*TODO: Describe the build targets that developers will use in daily *TODO: Describe the build targets that developers will use in daily
development. The examples below should fit most projects.* development. The examples below should fit most projects.*
| Target | Description | | Target | Description |
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ::compile = default | ::Compiles Java source code and creates .class files under the "build" directory. | | ::compile = default | ::Compiles Java source code and creates .class files under the "build" directory. |
| ::dist | ::Packages the system for distribution/deployment to servers or end users. Specifically, it creates .war archive of compiled classes and configuration files. | | ::dist | ::Packages the system for distribution/deployment to servers or end users. Specifically, it creates .war archive of compiled classes and configuration files. |
| ::install | ::Places executable code into location where it will actually be executed. Specifically, it copies .war file into Tomcat's webapps directory for use. You must then restart Tomcat or use the "reload" link in the Tomcat Manager. | | ::install | ::Places executable code into location where it will actually be executed. Specifically, it copies .war file into Tomcat's webapps directory for use. You must then restart Tomcat or use the "reload" link in the Tomcat Manager. |
| ::javadoc | ::Generates Java API documentation under "build/docs/api/". | | ::javadoc | ::Generates Java API documentation under "build/docs/api/". |
| ::clean | ::Deletes files generated by previous build commands. Files under version control are not touched. | | ::clean | ::Deletes files generated by previous build commands. Files under version control are not touched. |
### Build Configuration Options ### Build Configuration Options
| Property | Description | | Property | Description |
|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ::app.name | ::The name of this application. This should be one short word. Used in the name of resulting package files. Specifically, the .war file. And, it will be used to access the application via http://localhost:8080/APP.NAME/ | | ::app.name | ::The name of this application. This should be one short word. Used in the name of resulting package files. Specifically, the .war file. And, it will be used to access the application via <http://localhost:8080/APP.NAME/> |
| ::app.version | ::Version number of this release. Used in the name of resulting package files. Specifically, the .war file. | | ::app.version | ::Version number of this release. Used in the name of resulting package files. Specifically, the .war file. |
| ::webapps.path | ::Path to the Tomcat "webapps" directory. Defaults to C:\Program Files\Apache Group\Tomcat 4.1\webapps\ | | ::webapps.path | ::Path to the Tomcat "webapps" directory. Defaults to C:\Program Files\Apache Group\Tomcat 4.1\webapps\ |
@ -112,11 +113,11 @@ we have avoided the use of custom ant tasks.
#### Platform independence: To what extent has this been achieved? #### Platform independence: To what extent has this been achieved?
::We are using Ant, which is itself platform independent. The names ::We are using Ant, which is itself platform independent. The names
of the files and directories should work across platforms because of the files and directories should work across platforms because
they do not rely on case-sensitive names. We assume that the utility they do not rely on case-sensitive names. We assume that the utility
scripts in the "scripts" directory support all needed platforms and scripts in the "scripts" directory support all needed platforms and
we have not created directories for different versions of these files we have not created directories for different versions of these files
aimed at specific platforms. aimed at specific platforms.
#### Have these implementation decisions been communicated to the development team and other stakeholders? #### Have these implementation decisions been communicated to the development team and other stakeholders?

4
Design.md
View File

@ -1,3 +1,5 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)
@ -145,5 +147,5 @@ revised.*
#### Has the design been communicated to the development team and other stakeholders? #### Has the design been communicated to the development team and other stakeholders?
- ::Yes, everyone understands. Feedback is welcome. - ::Yes, everyone understands. Feedback is welcome.
- ::No, this is a risk that is noted in the - ::No, this is a risk that is noted in the
[Risk Management](Project-Plan#Risk-Management) section. [Risk Management](Project-Plan#Risk-Management) section.

4
Document-Cross-Ref.md
View File

@ -10,8 +10,8 @@ the software development workflow.
| Read By \ Written By | Everyone | Project Manager | Product Manager | Dev Team | QA Team | Tech Writer | Tech Support | Operations | Sales | | Read By \ Written By | Everyone | Project Manager | Product Manager | Dev Team | QA Team | Tech Writer | Tech Support | Operations | Sales |
|------------------------|-----------------|-----------------|-----------------|----------|---------|-------------|--------------|------------|-------| |------------------------|-----------------|-----------------|-----------------|----------|---------|-------------|--------------|------------|-------|
| ::Everyone | (Release-Checklist),[SDM](SDM) | | | | | | | | | | ::Everyone | [Release-Checklist],[SDM](SDM) | | | | | | | | |
| ::Project Manager | (Status-Report) | | | | | | | | | | ::Project Manager | [Status-Report] | | | | | | | | |
| ::Dev Team | | | | | | | | | | | ::Dev Team | | | | | | | | | |
| ::QA Team | | | | | | | | | | | ::QA Team | | | | | | | | | |
| ::Tech Writer | | | | | | | | | | | ::Tech Writer | | | | | | | | | |

1
_Footer.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
**TODO:** Check for [words of wisdom](Words-of-Wisdom) for additional advice on this template. **TODO:** Check for [words of wisdom](Words-of-Wisdom) for additional advice on this template.
::**Your-Organization Proprietary** ::**Your-Organization Proprietary**

3
_Sidebar.md
View File

@ -1,5 +1,6 @@
<!-- markdownlint-disable-next-line MD041 -->
* [Home](Home) * [Home](Home)
* [Summary](Summary) * [Summary](Summary)
* [Project Plan](Project-Plan) * [Project Plan](Project-Plan)
* [Workflows](Workflows) * [Workflows](Workflows)
* [Words of Wisdom](Words-of-Wisdom) * [Words of Wisdom](Words-of-Wisdom