Fix markdown lint errors

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

View File

@@ -1,4 +1,5 @@
<!-- markdownlint-disable-next-line MD041 -->
<!-- markdownlint-disable-next-line first-line-h1 -->
##### Project
::PROJECT-NAME
@@ -17,28 +18,28 @@
### Overview
*TODO: Briefly describe the approach to scalability. Rank your
scalability goals for this design.*
_TODO: Briefly describe the approach to scalability. Rank your
scalability goals for this design._
::2-4 SENTENCES.
### Relevant parameters
| Parameter | Description |
|---------------------|-----------------------------------------------------------------------------------------|
| ::registered\_users | ::Number of registered users in the database. |
| ::concurrent\_users | ::Number of users logged into the system at a given time. |
| ::map\_size | ::Number of game squares in the playing area. E.g., a 10 x 25 map would be 250 squares. |
| ::game\_pieces | ::Number of game pieces on the playing area at a given time. |
| Parameter | Description |
| ------------------ | --------------------------------------------------------------------------------------- |
| ::registered_users | ::Number of registered users in the database. |
| ::concurrent_users | ::Number of users logged into the system at a given time. |
| ::map_size | ::Number of game squares in the playing area. E.g., a 10 x 25 map would be 250 squares. |
| ::game_pieces | ::Number of game pieces on the playing area at a given time. |
### Scalability Mechanisms
### Performance Goals and Estimates
| Action | Goal | Time Formula | Description |
|----------------|--------------|-------------------------------|-----------------------------------------------------------------------------|
| ::login | ::1 second | ::O(Log(registered\_users)) | ::Time that it takes to look up a user by their login name in the database. |
| ::display\_map | ::1/5 second | ::O(map\_size + game\_pieces) | ::Time that it takes to redraw the game map and all game pieces. |
| Action | Goal | Time Formula | Description |
| ------------- | ------------ | --------------------------- | --------------------------------------------------------------------------- |
| ::login | ::1 second | ::O(Log(registered_users)) | ::Time that it takes to look up a user by their login name in the database. |
| ::display_map | ::1/5 second | ::O(map_size + game_pieces) | ::Time that it takes to redraw the game map and all game pieces. |
### System Scalability Checklist