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

feat(docs): Adds an "Edit this page on GitHub" button to docs pages #27176

Merged
merged 2 commits into from
Feb 21, 2024

Conversation

rusackas
Copy link
Member

SUMMARY

  • Changes Docusaurus config to take you to the actual edit link, so you can edit a given page on GitHub (or open a PR easily)
  • "Swizzles" the docs layout in order to add a new Edit button component.
  • Adds the component, as seen in this here GIF:

edit button

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@github-actions github-actions bot added the doc Namespace | Anything related to documentation label Feb 20, 2024
@rusackas rusackas merged commit 7e9361f into master Feb 21, 2024
28 checks passed
@rusackas rusackas deleted the docs-edit-button branch February 21, 2024 16:24
@sfirke
Copy link
Member

sfirke commented Feb 21, 2024

@rusackas this button works for me, I love it. But does it conflict with the BugHerd button? I'm not sure but I remember it being in the same place and now I don't see the BH button anywhere on a docs page.

@rusackas
Copy link
Member Author

I have the same curiosity... I'm not sure what happened to the BugHerd button. That needs investigation. Happy to move this to fit if needed when we figure that out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Namespace | Anything related to documentation size/M
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants