Add experimental links
This commit is contained in:
William Sandner
parent
e391771066
commit
245376ef2d
@ -1,3 +1,4 @@
|
||||
<!-- markdownlint-disable-next-line MD041 -->
|
||||
##### Project
|
||||
|
||||
::[PROJECT-NAME](Home)
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
<!-- markdownlint-disable-next-line MD041 -->
|
||||
##### Project
|
||||
|
||||
::PROJECT-NAME(Home)
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
<!-- markdownlint-disable-next-line MD041 -->
|
||||
##### Project
|
||||
|
||||
::PROJECT-NAME
|
||||
@ -51,7 +52,7 @@ made from other documents, issues, and email messages.*
|
||||
### C-01: COMPONENT NAME
|
||||
|
||||
**Description:**
|
||||
|
||||
|
||||
::DESCRIPTION
|
||||
|
||||
**Environmental Constraints:**
|
||||
|
||||
@ -1,10 +1,14 @@
|
||||
<!-- markdownlint-disable-next-line MD041 -->
|
||||
##### Project
|
||||
|
||||
::PROJECT-NAME
|
||||
|
||||
##### Internal Release Number
|
||||
|
||||
::X.Y.Z
|
||||
|
||||
##### Related Documents
|
||||
|
||||
- [Design](Design) > Design Persistence
|
||||
- ::LINKS TO RELEVANT STANDARDS
|
||||
- ::LINKS TO OTHER DOCUMENTS
|
||||
@ -17,6 +21,7 @@
|
||||
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?
|
||||
|
||||
::PARAGRAPH OR BULLETS
|
||||
|
||||
#### What are the ranked goals for persistence in this system?
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
<!-- markdownlint-disable-next-line MD041 -->
|
||||
##### Project
|
||||
|
||||
::PROJECT-NAME
|
||||
@ -49,5 +50,5 @@ How well do these mechanisms support the achievement of your goals?
|
||||
|
||||
::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.
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
<!-- markdownlint-disable-next-line MD041 -->
|
||||
##### Project
|
||||
|
||||
::PROJECT-NAME
|
||||
@ -70,19 +71,19 @@ overall structure or build process.*
|
||||
*TODO: Describe the build targets that developers will use in daily
|
||||
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. |
|
||||
| ::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. |
|
||||
| ::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. |
|
||||
|
||||
### Build Configuration Options
|
||||
### Build Configuration Options
|
||||
|
||||
| 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. |
|
||||
| ::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?
|
||||
|
||||
::We are using Ant, which is itself platform independent. The names
|
||||
of the files and directories should work across platforms because
|
||||
::We are using Ant, which is itself platform independent. The names
|
||||
of the files and directories should work across platforms because
|
||||
they do not rely on case-sensitive names. We assume that the utility
|
||||
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.
|
||||
|
||||
#### Have these implementation decisions been communicated to the development team and other stakeholders?
|
||||
|
||||
@ -1,3 +1,5 @@
|
||||
|
||||
<!-- markdownlint-disable-next-line MD041 -->
|
||||
##### Project
|
||||
|
||||
::[PROJECT-NAME](Home)
|
||||
@ -145,5 +147,5 @@ revised.*
|
||||
#### Has the design been communicated to the development team and other stakeholders?
|
||||
|
||||
- ::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.
|
||||
|
||||
@ -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 |
|
||||
|------------------------|-----------------|-----------------|-----------------|----------|---------|-------------|--------------|------------|-------|
|
||||
| ::Everyone | (Release-Checklist),[SDM](SDM) | | | | | | | | |
|
||||
| ::Project Manager | (Status-Report) | | | | | | | | |
|
||||
| ::Everyone | [Release-Checklist],[SDM](SDM) | | | | | | | | |
|
||||
| ::Project Manager | [Status-Report] | | | | | | | | |
|
||||
| ::Dev Team | | | | | | | | | |
|
||||
| ::QA Team | | | | | | | | | |
|
||||
| ::Tech Writer | | | | | | | | | |
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
<!-- markdownlint-disable-next-line MD041 -->
|
||||
**TODO:** Check for [words of wisdom](Words-of-Wisdom) for additional advice on this template.
|
||||
|
||||
::**Your-Organization Proprietary**
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
<!-- markdownlint-disable-next-line MD041 -->
|
||||
* [Home](Home)
|
||||
* [Summary](Summary)
|
||||
* [Project Plan](Project-Plan)
|
||||
* [Workflows](Workflows)
|
||||
* [Words of Wisdom](Words-of-Wisdom)
|
||||
* [Words of Wisdom](Words-of-Wisdom
|
||||
|
||||
Loading…
Reference in New Issue
Block a user