git audacity pr post formatting
This commit is contained in:
		
							parent
							
								
									0c994bf6f3
								
							
						
					
					
						commit
						30ee3b594a
					
				| 
						 | 
				
			
			@ -23,7 +23,7 @@ When I reference comments, I'll provide a footnote that includes a link to the
 | 
			
		|||
comment and a link to a screenshot just in case it's removed or edited in the
 | 
			
		||||
future.
 | 
			
		||||
 | 
			
		||||
## Audacity's acquisition {#audacity-s-acquisition}
 | 
			
		||||
## Audacity's acquisition
 | 
			
		||||
 | 
			
		||||
I haven't been able to find _much_ information in this area so forgive me if I'm
 | 
			
		||||
scant on details.
 | 
			
		||||
| 
						 | 
				
			
			@ -63,9 +63,9 @@ have high hopes that this is the case.
 | 
			
		|||
 | 
			
		||||
`------END PERSONAL OPINION------`
 | 
			
		||||
 | 
			
		||||
## Telemetry implementation {#telemetry-implementation}
 | 
			
		||||
## Telemetry implementation
 | 
			
		||||
 | 
			
		||||
### Implementation Basics {#implementation-basics}
 | 
			
		||||
### Implementation Basics
 | 
			
		||||
 | 
			
		||||
A few days after the acquisition, a PR was opened that adds _Basic telemetry for
 | 
			
		||||
the Audacity_. This implementation collects "application opened" events and
 | 
			
		||||
| 
						 | 
				
			
			@ -79,7 +79,7 @@ including release. This description was mostly copied directly from [the PR
 | 
			
		|||
description
 | 
			
		||||
itself.](https://github.com/audacity/audacity/pull/835#issue-629891447)
 | 
			
		||||
 | 
			
		||||
### Frontend Implementation {#frontend-implementation}
 | 
			
		||||
### Frontend Implementation
 | 
			
		||||
 | 
			
		||||
This is fairly straightforward and a pretty standard UI for prompting users to
 | 
			
		||||
consent to analytics and crash logging. This section is included because the
 | 
			
		||||
| 
						 | 
				
			
			@ -87,13 +87,9 @@ community has strong opinions regarding the language used and its design, but
 | 
			
		|||
that will be discussed later. The screenshot below is copied directly from the
 | 
			
		||||
PR.
 | 
			
		||||
 | 
			
		||||
{{< figure
 | 
			
		||||
src="~/repos/sites/secluded/static/assets/pngs/audacity-pr/consentdialogue.png"
 | 
			
		||||
link="~/repos/sites/secluded/static/assets/pngs/audacity-pr/consentdialogue.png"
 | 
			
		||||
{{< figure src="~/repos/sites/secluded/static/assets/pngs/audacity-pr/consentdialogue.png" link="~/repos/sites/secluded/static/assets/pngs/audacity-pr/consentdialogue.png" >}}
 | 
			
		||||
 | 
			
		||||
> }}
 | 
			
		||||
 | 
			
		||||
### Backend Implementation {#backend-implementation}
 | 
			
		||||
### Backend Implementation
 | 
			
		||||
 | 
			
		||||
Many of the code reviews include the reviewer's personal opinion so I will
 | 
			
		||||
summarise the comment, provide the code block in question, and link directly to
 | 
			
		||||
| 
						 | 
				
			
			@ -167,14 +163,14 @@ and [spelling errors in the
 | 
			
		|||
comments.](https://github.com/audacity/audacity/pull/835#discussion_r628818054)
 | 
			
		||||
I believe these are less important than those above so they won't be discussed.
 | 
			
		||||
 | 
			
		||||
## Community opinions {#community-opinions}
 | 
			
		||||
## Community opinions
 | 
			
		||||
 | 
			
		||||
There were many strong opinions regarding both the frontend and backend
 | 
			
		||||
implementations of this PR, from the wording of the dialogue and highlighting
 | 
			
		||||
the consent button to devices running something other than Windows and macOS not
 | 
			
		||||
being able to send telemetry and thus skewing the data that _was_ collected.
 | 
			
		||||
 | 
			
		||||
### Opinions on the frontend {#opinions-on-the-frontend}
 | 
			
		||||
### Opinions on the frontend
 | 
			
		||||
 | 
			
		||||
Really, the only frontend here is the consent dialogue. However, there are
 | 
			
		||||
_many_ comments about it, the most common of which is probably that the wording
 | 
			
		||||
| 
						 | 
				
			
			@ -227,7 +223,7 @@ state of the
 | 
			
		|||
page](https://web.archive.org/web/20210510012924/https://www.audacityteam.org/contact/privacy-policy/)
 | 
			
		||||
in case that changes in the future.
 | 
			
		||||
 | 
			
		||||
### Opinions on the backend {#opinions-on-the-backend}
 | 
			
		||||
### Opinions on the backend
 | 
			
		||||
 | 
			
		||||
```c
 | 
			
		||||
  if (!inputFile.Write (wxString::FromUTF8 (ClientID + "\n")))
 | 
			
		||||
| 
						 | 
				
			
			@ -293,7 +289,7 @@ adding telemetry in the first place.
 | 
			
		|||
There was a lot of feedback about the decision to highlight the consent button
 | 
			
		||||
but that was mentioned up in the frontend section; I won't rehash it here.
 | 
			
		||||
 | 
			
		||||
### Broader and particularly well-structured comments {#broader-and-particularly-well-structured-comments}
 | 
			
		||||
### Broader and particularly well-structured comments
 | 
			
		||||
 | 
			
		||||
These are simply some comments I feel deserve particular attention.
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -302,11 +298,11 @@ From SndChaser...
 | 
			
		|||
- [834037351](https://github.com/audacity/audacity/pull/835#issuecomment-834037351)
 | 
			
		||||
-
 | 
			
		||||
 | 
			
		||||
## The Audacity team's response {#the-audacity-team-s-response}
 | 
			
		||||
## The Audacity team's response
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
## The privacy policy modification {#the-privacy-policy-modification}
 | 
			
		||||
## The privacy policy modification
 | 
			
		||||
 | 
			
		||||
<https://github.com/audacity/audacity/issues/1213#issuecomment-875274890>
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
		Reference in New Issue