-
-
Notifications
You must be signed in to change notification settings - Fork 76
Replace svg diagrams with mermaid where possible. #513
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
anenadic
wants to merge
2
commits into
main
Choose a base branch
from
switch-to-mermaid
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+99
−155
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -21,30 +21,27 @@ exercises: 0 | |||||||||||||||||||
| In this section, we will take a step back from coding development practices and tools | ||||||||||||||||||||
| and look at the bigger picture of software as a *process* of development. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| <!-- | ||||||||||||||||||||
| alt="Topics on software engineering process covered in the current section: gathering requirements, software architecture & design, programming paradigms" | ||||||||||||||||||||
| --> | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ```mermaid | ||||||||||||||||||||
| flowchart LR | ||||||||||||||||||||
| accDescr {Topics on software engineering process covered in the current section: gathering requirements, software architecture & design, programming paradigms} | ||||||||||||||||||||
| A(1. Setting up software environment) | ||||||||||||||||||||
| A --> B(2. Verifying software correctness) | ||||||||||||||||||||
| B --> C(3. Software development as a process | ||||||||||||||||||||
| - Software requirements | ||||||||||||||||||||
| - Software architecture & design | ||||||||||||||||||||
| - Programming paradigms) | ||||||||||||||||||||
|
Comment on lines
+33
to
+36
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||
| C --> D(4. Collaborative development for reuse) | ||||||||||||||||||||
| D --> E(5. Managing software over its lifetime) | ||||||||||||||||||||
| ``` | ||||||||||||||||||||
|
|
||||||||||||||||||||
| > *"If you fail to plan, you are planning to fail."* | ||||||||||||||||||||
| > | ||||||||||||||||||||
| > --- Benjamin Franklin | ||||||||||||||||||||
|
|
||||||||||||||||||||
| {alt='Software design and architecture overview flowchart'} | ||||||||||||||||||||
|
|
||||||||||||||||||||
| <!--- | ||||||||||||||||||||
| Source of the above image can be rendered in the Mermaid live editor: | ||||||||||||||||||||
|
|
||||||||||||||||||||
| <https://mermaid.live/edit#pako:eNplkU1rwzAMhv-K8WGk0Ab2dclhsLW9rTBW2GH4oiVKakikTJZTSul_n9M122A-2dKj95Wsoy25QlvYuuV9uQNR8_zq6DG7zs0WVT01JvaOAte6B0GDNHhh6pB05mixeDBP2U1u3lB8fUj0H7RkESyVMIQLusxuk-yUr3DAlvtRyhEEA6YXLhPtyJFJZ_HLCn5GLziy4V8SpNx5TVYxPa6SbvDNj8SLcCPQdeMkPQhUvukuEpeuVtldbpbctvDBAuoHdPSnN1OzJP8Y8MKvs_vcbICgGTWncR3xgGK8BtP6GtV3OLNz26F04Kv0w8fR1FndpSmcLdK1whpiq846OiUUovL2QKUtVCLObewrUFx5GPu3RQ1tSFGsvLJsvrd2Xt5Ers-ZqboHemee6k5flmapmQ> | ||||||||||||||||||||
|
|
||||||||||||||||||||
| The mermaid source (with one less dash in arrows than needed): | ||||||||||||||||||||
|
|
||||||||||||||||||||
| flowchart LR | ||||||||||||||||||||
| A(1. Setting up software environment) | ||||||||||||||||||||
| A -> B(2. Verifying software correctness) | ||||||||||||||||||||
| B -> C(3. Software development as a process | ||||||||||||||||||||
| - Software requirements | ||||||||||||||||||||
| - Software architecture & design | ||||||||||||||||||||
| - Programming paradigms) | ||||||||||||||||||||
| C -> D(4. Collaborative development for reuse) | ||||||||||||||||||||
| D -> E(5. Managing software over its lifetime) | ||||||||||||||||||||
| --> | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Writing Code vs Engineering Software | ||||||||||||||||||||
|
|
||||||||||||||||||||
| Traditionally in academia, software - and the process of writing it - | ||||||||||||||||||||
|
|
||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -46,33 +46,19 @@ using **Poetry** to manage our Python dependencies | |||||||||||||||||||||
| and produce a code package we can use with a Python package indexing service | ||||||||||||||||||||||
| to illustrate these principles. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| {alt='Software design and architecture' .image-with-shadow width="1000px" } | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| <!-- | ||||||||||||||||||||||
| Source of the above image can be rendered in the Mermaid live editor: | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| https://mermaid.live/edit#pako:eNpVkE9rwzAMxb-K8CmFNrB_lxwGW9vbellhh-GLlsitIZGCrKSU0u8-t2vYpouF9HsP-Z1cLQ25yoVWDvUe1eDt3fNLcVfClswi72DoPScJdkAlIB6jCnfENvO8WDzDa3FfwgdpDMdM_0FrUaXamFK6ocviIdtO-4ZGaqW_WHnGBAi9Sv1Lr4rHEpbStvglihZH8vxHA0EUlIaUx54h1wL-vzefdfFUwgYZd5ffTOd5lpEUoiVoYyCLHc3c3HWkHcYmJ3K6mHhne-rIuyq3DQUcWvPO8zmjOJhsj1y7ynSguRv6Bo1WEXeKnasCtilPqYkmuvlJ-Rr2RK6vm0ndI3-KTLrzNzfGi8o | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| The mermaid source (with one less dash in arrows than needed): | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| flowchart LR | ||||||||||||||||||||||
| A(1. Setting up | ||||||||||||||||||||||
| software environment) | ||||||||||||||||||||||
| -> B(2. Verifying | ||||||||||||||||||||||
| software correctness) | ||||||||||||||||||||||
| -> C(3. Software development | ||||||||||||||||||||||
| as a process) | ||||||||||||||||||||||
| -> D(4. Collaborative | ||||||||||||||||||||||
| development for reuse | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| - Code review | ||||||||||||||||||||||
| - Software documentation | ||||||||||||||||||||||
| - Software packaging & release | ||||||||||||||||||||||
| ) | ||||||||||||||||||||||
| -> E(5. Managing software | ||||||||||||||||||||||
| over its lifetime) | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| --> | ||||||||||||||||||||||
| ```mermaid | ||||||||||||||||||||||
| flowchart LR | ||||||||||||||||||||||
| accDescr {Topics on collaborative software development covered in the current section: code review, writing software documentation, packaging & releasing software} | ||||||||||||||||||||||
| A(1. Setting up software environment) | ||||||||||||||||||||||
| A --> B(2. Verifying software correctness) | ||||||||||||||||||||||
| B --> C(3. Software development as a process) | ||||||||||||||||||||||
| C --> D(4. Collaborative development for reuse | ||||||||||||||||||||||
| - Code review | ||||||||||||||||||||||
| - Software documentation | ||||||||||||||||||||||
| - Software packaging & release | ||||||||||||||||||||||
| ) | ||||||||||||||||||||||
|
Comment on lines
+55
to
+59
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||
| D --> E(5. Managing software over its lifetime) | ||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -30,33 +30,22 @@ how the outside world interacts with and makes use of our software, | |||||||||||||||||||||
| how others can interact with ourselves to report issues, | ||||||||||||||||||||||
| and the ways we can successfully manage software improvement in response to feedback. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| {alt='Managing software' .image-with-shadow width="1000px" } | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| <!-- | ||||||||||||||||||||||
| Source of the above image can be rendered in the Mermaid live editor: | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| https://mermaid.live/edit#pako:eNpNkMtqw0AMRX9FzMqBxNDXxotCm2TXbBroosxGtTXJgC0ZjewQQv69k4dpF0JCOvci7snV0pCrXGjlUO9RDT4-Pb8VDyVsySzyDobec5JgB1QC4jGqcEdsM8-LxSu8F48lfJHGcMz0P7QWVaqNKaU7uiyesu10b2ikVvqLlWdMgNCr1H_0qnguYSltiz-iaHEkz_80EERBaUh059fFSwkbZNxdvp7e8CwjKURL0MZAFru8ygLIdWszN3cdaYexyUGcPAN4Z3vKoKvy2FDAoTXvPJ8zioPJ9si1q0wHmruhb9BoFXGn2LkqYJvylppooptbuNeMJ3J9vUzqHvlbZNKdfwFSLYtB | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| The mermaid source (with one less dash in arrows than needed): | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| flowchart LR | ||||||||||||||||||||||
| A(1. Setting up | ||||||||||||||||||||||
| software environment) | ||||||||||||||||||||||
| -> B(2. Verifying | ||||||||||||||||||||||
| software correctness) | ||||||||||||||||||||||
| -> C(3. Software development | ||||||||||||||||||||||
| as a process) | ||||||||||||||||||||||
| -> D(4. Collaborative | ||||||||||||||||||||||
| development for reuse) | ||||||||||||||||||||||
| -> E(5. Managing software | ||||||||||||||||||||||
| over its lifetime | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| - Issue reporting & prioritisation | ||||||||||||||||||||||
| - Agile development in sprints | ||||||||||||||||||||||
| - software project management | ||||||||||||||||||||||
| ) | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| <!-- | ||||||||||||||||||||||
| alt="Topics on collaborative software development covered in the current section: issue management, project management, agile development" | ||||||||||||||||||||||
| --> | ||||||||||||||||||||||
| ```mermaid | ||||||||||||||||||||||
| flowchart LR | ||||||||||||||||||||||
| accDescr {Topics on collaborative software development covered in the current section: issue management, project management, agile development} | ||||||||||||||||||||||
| A(1. Setting up software environment) | ||||||||||||||||||||||
| A --> B(2. Verifying software correctness) | ||||||||||||||||||||||
| B --> C(3. Software development as a process) | ||||||||||||||||||||||
| C --> D(4. Collaborative development for reuse) | ||||||||||||||||||||||
| D --> E(5. Managing software over its lifetime | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| - Issue reporting & prioritisation | ||||||||||||||||||||||
| - Agile development in sprints | ||||||||||||||||||||||
| - Software project management) | ||||||||||||||||||||||
|
Comment on lines
+43
to
+47
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| In this section we will: | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Matching using Markdown formatting as in
10-section-1-intro.md