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

Fix markdown lint errors

Browse Source
This commit is contained in:
William Sandner
2023-03-24 17:29:16 +01:00
parent 0d20f4e5b1
commit c504fc26da
50 changed files with 702 additions and 637 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
Implementation-Notes.md
View File

@@ -1,4 +1,5 @@
<!-- markdownlint-disable-next-line MD041 -->
<!-- markdownlint-disable-next-line first-line-h1 -->
##### Project
::[PROJECT-NAME](Home)
@@ -30,9 +31,9 @@ guide".
### Type of Implementation
*TODO: Fill in information that will help other engineers understand this
_TODO: Fill in information that will help other engineers understand this
system at-a-glance. Feel free to use relevant technical terms and name
specific technology platforms.*
specific technology platforms._
#### Type of system
@@ -75,8 +76,8 @@ specific technology platforms.*
### Runtime Environment
*TODO: List and describe runtime objects that make up a running system.
These objects may be referred to by name in the sections below.*
_TODO: List and describe runtime objects that make up a running system.
These objects may be referred to by name in the sections below._
#### Processes
@@ -99,7 +100,7 @@ These objects may be referred to by name in the sections below.*
#### Data Files
- ::*.ext: Data files saved by the user on their local hard disk.
- ::\*.ext: Data files saved by the user on their local hard disk.
- ::/var/PRODUCT-NAME/upload-XXXX.dat: Files uploaded to the server.
#### Temporary Files
@@ -115,11 +116,11 @@ These objects may be referred to by name in the sections below.*
### Implementation of Specific Features
*TODO: Write short descriptions of interesting or unexpected algorithms,
_TODO: Write short descriptions of interesting or unexpected algorithms,
limiting assumptions, or any other implementation detail that will
impact the work of other groups. E.g., long-running operations that must
not be interrupted. E.g., start up or shutdown scripts that are
automatically run by the operating system.*
automatically run by the operating system._
- ::Feature name: 1-3 SENTENCE DESCRIPTION
- ::Feature name: 1-3 SENTENCE DESCRIPTION
@@ -134,8 +135,8 @@ automatically run by the operating system.*
### Operational Procedures
*TODO: Briefly describe procedures that should be followed by operations
engineers when the system is being run in an ASP production environment.*
_TODO: Briefly describe procedures that should be followed by operations
engineers when the system is being run in an ASP production environment._
#### Install
@@ -173,8 +174,8 @@ engineers when the system is being run in an ASP production environment.*
### Security
*TODO: Write notes on security to help operations engineers keep the
system secure while it is in operation.*
_TODO: Write notes on security to help operations engineers keep the
system secure while it is in operation._
We take the following precautions to make the system secure
@@ -190,8 +191,8 @@ The security of the system depends on the following external factors
### Performance and Scalability
*TODO: Write notes on performance and scalability to help operations
engineers operate the system efficiently.*
_TODO: Write notes on performance and scalability to help operations
engineers operate the system efficiently._
::NOTES ON PERFORMANCE.