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

Update docs links using the key for searching and not replacing the content #45958

Conversation

bethanyaconnor
Copy link
Contributor

@bethanyaconnor bethanyaconnor commented Apr 22, 2022

Continuation of #45927.

Three things changed from that script:

  1. looking for blocks on key instead of name got most of these files
  2. As Tim pointed out, the query.count == 1 condition was too constrictive so I wrote a little heuristic to link to the doc in the same programming environment. Any ambiguous ones I added to the list of docs to do a pass on.
  3. Don't replace the string with the name, instead keep the text that is already there and add the extra markdown syntax around it

Links

Testing story

Deployment strategy

Follow-up work

Privacy

Security

Caching

PR Checklist:

  • Tests provide adequate coverage
  • Privacy and Security impacts have been assessed
  • Code is well-commented
  • New features are translatable or updates will not break translations
  • Relevant documentation has been added or updated
  • User impact is well-understood and desirable
  • Pull Request is labeled appropriately
  • Follow-up work items (including potential tech debt) are tracked and linked

@bethanyaconnor bethanyaconnor changed the title Update docs links using the key for searching and not replacing the c… Update docs links using the key for searching and not replacing the content Apr 22, 2022
@bethanyaconnor bethanyaconnor marked this pull request as ready for review April 22, 2022 22:03
@bethanyaconnor bethanyaconnor requested review from tess323, tim-dot-org and a team April 22, 2022 22:03
@tess323
Copy link

tess323 commented Apr 23, 2022

This looks great - thank you

@bethanyaconnor bethanyaconnor merged commit bef793a into staging Apr 25, 2022
@bethanyaconnor bethanyaconnor deleted the bethany/update-docs-links-code-docs-reference-guides-2.2 branch April 25, 2022 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants