documentation
documentation copied to clipboard
Change the "Edit this page on GitHub" link to use built-in GitHub IDE (VSCode)
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
toblob/something-else
but would need to confirm and understand how to make that dynamic to the PR.