Fix formatting for nested code elements in README.md #215
Conversation
This file contains 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
GitHub flavored MD can be finicky about blending MD with HTML. For the Summary/Description blocks, some of the code references were not displaying properly. Instead, they were showing unformatted with surrounding backticks. To resolve this, I changed inline ones to <code></code> blocks and added an extra line between some content.
ThomasLaPiana
approved these changes
Nov 9, 2021
|
@iamkelllly feel free to merge unless you find an issue in review |
|
@iamkelllly jk this is a simple change, no need to put more on your plate, going to go ahead and merge |
ThomasLaPiana
pushed a commit
that referenced
this pull request
Aug 17, 2022
Adds query execution (access and erasure) support for BigQuery.
ThomasLaPiana
pushed a commit
that referenced
this pull request
Aug 17, 2022
* Implements initial privacy center layout * Implement privacy request modal * 80 Query Execution BigQuery (#215) Adds query execution (access and erasure) support for BigQuery. * makes client_id optional on the PrivacyRequest model * makes PrivacyRequestCreate.requested_at optional, and default to datetime.utcnow() in the API view * remove authentication requirements from privacy request create tests * Update request format slightly * Switch to babel for compilation to prevent swc build error * Implement alerts * Implement optionally required fields * Move types out of ignored lib folder * Commit updated files referring to types * Tweak styles to match Figma designs * Correct action card layout for all numbers of cards * Correct logo placement behind alerts * Correct merge changes * Implement testing * Document functionality in README * Correct README header * Correct deployment instructions * Move test setup file to __tests__ folder * simplify initial config * Address PR comments - Remove .env.development file as config lives in `config/config.json` - Update docs to include instructions to `npm install` - Add `test:ci` command - Remove email validation from form - Add anchor logo on 404 page Co-authored-by: Catherine Smith <eastandwestwind@gmail.com> Co-authored-by: Sean Preston <sean@ethyca.com>
ThomasLaPiana
pushed a commit
that referenced
this pull request
Aug 17, 2022
* Implements initial privacy center layout * Implement privacy request modal * 80 Query Execution BigQuery (#215) Adds query execution (access and erasure) support for BigQuery. * makes client_id optional on the PrivacyRequest model * makes PrivacyRequestCreate.requested_at optional, and default to datetime.utcnow() in the API view * remove authentication requirements from privacy request create tests * Update request format slightly * Switch to babel for compilation to prevent swc build error * Implement alerts * Implement optionally required fields * Move types out of ignored lib folder * Commit updated files referring to types * Tweak styles to match Figma designs * Correct action card layout for all numbers of cards * Correct logo placement behind alerts * Correct merge changes * Implement testing * Document functionality in README * Correct README header * Correct deployment instructions * Move test setup file to __tests__ folder * simplify initial config * Address PR comments - Remove .env.development file as config lives in `config/config.json` - Update docs to include instructions to `npm install` - Add `test:ci` command - Remove email validation from form - Add anchor logo on 404 page * Update README to include note about CSS customization * Reapply README change * Remove manual line wrapping from README.md * Implement UI mock of requests management page * Improve layout fidelity to designs * Initialize state management with redux-toolkit * Implement API mock * Implement mock server * Implement login, data retrieval, PII obscuring * Begin implementing request filters * Implement ID copying * Implement searching by ID * Implement CSV download * Add policy tag * adds a data migration to seed some example policies and privacy requests * autocommit enum field changes so we can use them in the subsequent migration * Implement Approve / Deny requests * Implement pagination * Implement auth redirect, pagination filter reset * Correct recursive imports by adding type prefix * Replace hardcoded endpoints with env variables * Correct tab focus handling on request table rows * Add shadow to row action hover menu * Disabled unsupported nav links * Add border radius to inputs * Remove unnecessary auth env variable * Response to review comments * Expand README * Revert "adds a data migration to seed some example policies and privacy requests" This reverts commit 3376b0399d9e90d6aa900eb6583e25a9673baeef. * Revert "autocommit enum field changes so we can use them in the subsequent migration" This reverts commit ae8a64810defb376c2ef9099489737942250afae. * Grab correct reviewer field Co-authored-by: Catherine Smith <eastandwestwind@gmail.com> Co-authored-by: Sean Preston <sean@ethyca.com>
ThomasLaPiana
pushed a commit
that referenced
this pull request
Sep 26, 2022
Adds query execution (access and erasure) support for BigQuery.
ThomasLaPiana
pushed a commit
that referenced
this pull request
Sep 26, 2022
* Implements initial privacy center layout * Implement privacy request modal * 80 Query Execution BigQuery (#215) Adds query execution (access and erasure) support for BigQuery. * makes client_id optional on the PrivacyRequest model * makes PrivacyRequestCreate.requested_at optional, and default to datetime.utcnow() in the API view * remove authentication requirements from privacy request create tests * Update request format slightly * Switch to babel for compilation to prevent swc build error * Implement alerts * Implement optionally required fields * Move types out of ignored lib folder * Commit updated files referring to types * Tweak styles to match Figma designs * Correct action card layout for all numbers of cards * Correct logo placement behind alerts * Correct merge changes * Implement testing * Document functionality in README * Correct README header * Correct deployment instructions * Move test setup file to __tests__ folder * simplify initial config * Address PR comments - Remove .env.development file as config lives in `config/config.json` - Update docs to include instructions to `npm install` - Add `test:ci` command - Remove email validation from form - Add anchor logo on 404 page Co-authored-by: Catherine Smith <eastandwestwind@gmail.com> Co-authored-by: Sean Preston <sean@ethyca.com>
ThomasLaPiana
pushed a commit
that referenced
this pull request
Sep 26, 2022
* Implements initial privacy center layout * Implement privacy request modal * 80 Query Execution BigQuery (#215) Adds query execution (access and erasure) support for BigQuery. * makes client_id optional on the PrivacyRequest model * makes PrivacyRequestCreate.requested_at optional, and default to datetime.utcnow() in the API view * remove authentication requirements from privacy request create tests * Update request format slightly * Switch to babel for compilation to prevent swc build error * Implement alerts * Implement optionally required fields * Move types out of ignored lib folder * Commit updated files referring to types * Tweak styles to match Figma designs * Correct action card layout for all numbers of cards * Correct logo placement behind alerts * Correct merge changes * Implement testing * Document functionality in README * Correct README header * Correct deployment instructions * Move test setup file to __tests__ folder * simplify initial config * Address PR comments - Remove .env.development file as config lives in `config/config.json` - Update docs to include instructions to `npm install` - Add `test:ci` command - Remove email validation from form - Add anchor logo on 404 page * Update README to include note about CSS customization * Reapply README change * Remove manual line wrapping from README.md * Implement UI mock of requests management page * Improve layout fidelity to designs * Initialize state management with redux-toolkit * Implement API mock * Implement mock server * Implement login, data retrieval, PII obscuring * Begin implementing request filters * Implement ID copying * Implement searching by ID * Implement CSV download * Add policy tag * adds a data migration to seed some example policies and privacy requests * autocommit enum field changes so we can use them in the subsequent migration * Implement Approve / Deny requests * Implement pagination * Implement auth redirect, pagination filter reset * Correct recursive imports by adding type prefix * Replace hardcoded endpoints with env variables * Correct tab focus handling on request table rows * Add shadow to row action hover menu * Disabled unsupported nav links * Add border radius to inputs * Remove unnecessary auth env variable * Response to review comments * Expand README * Revert "adds a data migration to seed some example policies and privacy requests" This reverts commit 4d1628132929312cd749bde49e37c0108bc2bf79. * Revert "autocommit enum field changes so we can use them in the subsequent migration" This reverts commit c9a2587b4355e1d5acf37fa28461cbdd61ec931e. * Grab correct reviewer field Co-authored-by: Catherine Smith <eastandwestwind@gmail.com> Co-authored-by: Sean Preston <sean@ethyca.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Code Changes
Steps to Confirm
View the rendered
README.mdat the root of the repository in GitHub.https://github.com/ethyca/fides/blob/rkeyser-readme-formatting/README.md
Pre-Merge Checklist
Description Of Changes
GitHub flavored MD can be finicky about blending MD with HTML. For the Summary/Description blocks, some of the code references were not displaying properly. Instead, they were showing unformatted with surrounding backticks. To resolve this, I changed inline ones to
<code> ... </code>blocks and added an extra line between some content.It originally looked like this:
And now it looks like this:
