Skip to content
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

Fix double single quotes in metaDescription and wrap everything in double quotes #2261

Closed
wants to merge 4 commits into from

Conversation

bradleycamacho
Copy link
Contributor

This PR removes all double single quotes in metaDescriptions, and wraps all metaDescriptions in double quotes instead.

This built correctly, and I scanned a few dozen individual docs to ensure everything got replaced correctly. Please double check for me if you review this :)

Attaching the regEx I used as screenshots:
Screen Shot 2021-05-12 at 12 29 02 PM
Screen Shot 2021-05-12 at 12 22 54 PM

@bradleycamacho bradleycamacho added content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers) labels May 12, 2021
@github-actions github-actions bot added this to Needs Triage in Docs PRs and Issues May 12, 2021
@bradleycamacho bradleycamacho moved this from Needs Triage to Any TW: Writer needs PR review in Docs PRs and Issues May 12, 2021
@bradleycamacho
Copy link
Contributor Author

Original commit did not exclude Japanese docs. Reverted that commit and pushed two separate commits which exclude Japanese docs.

@bradleycamacho bradleycamacho removed the request for review from austin-schaefer May 12, 2021 19:49
@austin-schaefer austin-schaefer self-requested a review May 12, 2021 20:28
@austin-schaefer
Copy link
Collaborator

Building this locally now

@austin-schaefer
Copy link
Collaborator

Looks like there are still 13 files with double quotes in metaDescription:

image

Copy link
Collaborator

@austin-schaefer austin-schaefer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @bradleycamacho , looks good but noticed a few docs where there are still some double-single-quotes in the metadescription. See screenshot. Thanks for doing this cleanup!

@@ -4,7 +4,7 @@ tags:
- Agents
- Nodejs agent
- Troubleshooting
metaDescription: 'To reduce disk space consumption, be sure to lower the ''trace'' log level after generating a troubleshooting log for your New Relic Node.js agent.'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this case with doubled up double single quotes (if that makes any sense) wasn't handled quite right. Not sure how common this is but probably worth re-searching for.

@barbnewrelic barbnewrelic moved this from Any TW: Writer needs PR review to In review (Hero or any TW) in Docs PRs and Issues May 12, 2021
@austin-schaefer austin-schaefer moved this from In review (Hero or any TW) to Waiting on TW to merge in Docs PRs and Issues May 13, 2021
@bradleycamacho bradleycamacho moved this from Waiting on TW to merge to In review (Hero or any TW) in Docs PRs and Issues May 13, 2021
@bradleycamacho
Copy link
Contributor Author

No longer seems worth the effort.

If anyone ever reopens in the future, be sure to implement the fixes mentioned above and ensure merge conflicts are fixed.

@bradleycamacho bradleycamacho added from_tw Identifies issues/PRs from Tech Docs writers and removed from_internal Identifies issues/PRs from Relics (except writers) labels Mar 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers
Projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants