Change the "Edit this page on GitHub" link to use built-in GitHub IDE (VSCode)

jazzsequence commented 1 year ago

Priority: Low

Issue Description

Now that GitHub has built-in VSCode at github.dev, perhaps we should change the "edit this page" link from the old plain text editor to the new VSCode IDE? Or add that as a third option?

The relevant code appears to be here and I think that the change (if we swapped) would just be to change

      <a
        href={`https://github.com/pantheon-systems/documentation/edit/main/${editPath}`}
        target="blank"
      >

with

      <a
        href={`https://github.dev/pantheon-systems/documentation/blob/main/${editPath}`}
        target="blank"
      >

How will this impact users?

More robust tools for editing docs and (perhaps) an easier workflow for users (and Pantheors) making changes to docs.
The risk is that the workflow does not default to opening a new branch (although I don't think that non-Pantheors can commit to main, so the process would need to be tested. This might be a wild goose chase if there's not good in-app messaging to change the branch.

Additional Information

It might be possible (have not investigated) to change the branch by default by just editing the link from /blob/main to blob/something-else but would need to confirm and understand how to make that dynamic to the PR.

stevector commented 2 months ago

I personally prefer the existing behavior with the plain text editor, not the IDE.

jazzsequence commented 2 months ago

:whynotboth: We could have two buttons, or a dropdown to choose, or something. I find that I'm far more comfortable in the github.dev version, but I get that that might be too much/overkill for folks less familiar with it. On the other hand, not having a way to (easily) open the page in the VSCode/IDE integration makes it actively cumbersome to get back to the doc in question (which is really the core issue that I opened this to address).

stevector commented 1 month ago

I'd be fine doing both. Are you interested in learning about the front-end development / React parts of the Docs site? This could be a good task to bring in a component from the design system: https://live-pds-toolkit-react.appa.pantheon.site/?path=/docs/components-buttons-menu-button--docs

jazzsequence commented 1 month ago

@stevector I'd be down for learning about that side of things. 👍
I want to start dusting off my JS/React skills anyway.

pantheon-systems / documentation