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

[Feature] A whole new feature called FastPR #778

Open
frank-zsy opened this issue Mar 5, 2024 · 2 comments
Open

[Feature] A whole new feature called FastPR #778

frank-zsy opened this issue Mar 5, 2024 · 2 comments
Assignees
Labels
kind/feature Category issues or prs related to feature request.

Comments

@frank-zsy
Copy link
Contributor

Description

As the analysis in 2023 China Open Source Report, openEuler embedded a cloud IDE in their website to improve the experience for developers who want to contribute to their docs.

The feature is really helpful for open source projects to attract developers and users of their projects to contribute the docs and fix bugs in the docs for community. And I think HyperCRX is a good form to implement this feature for projects' websites.

As shown in the video below, we can add a Markdown editor for all the docs page and after user closes the editor, HyperCRX can open a new PR in the corresponding repo for the user if GitHub token is set.

normal.video.mp4
@wangyantong2000
Copy link
Collaborator

Next, I will follow up on this issue.

@wangyantong2000 wangyantong2000 self-assigned this Oct 8, 2024
@frank-zsy
Copy link
Contributor Author

@wangyantong2000 Thanks. I think there are several things we need to take care about:

  • First we should refactor the extension's load mechanism to support all website rather than only GitHub, and all the GitHub feature right now should only be loaded in GitHub. This could be an independent feature and a new issue.
  • Then we need to design how to config the load setting of this feature, that I think is:
    • The domain name of the docs website, like open-digger.cn which is the docs website of OpenDigger.
    • The corresponding platform, repository and development branch of the website, like github, X-lab2017/open-digger-website and master.
    • The supported pages and the rules to get the raw markdown file. It is tricky here because the rule could be complex and we should decide that does we support script here or just use regex here. I prefer the script but it requires js config file rather than json format.
    • And the config file above should not be inside the extension release and should be fetched from remote URL and update regularly. Which makes it possible to add new config dynamically without update the extension it self.
  • Then it is the procedure to raise PR directly from the website page and we should also add a confirm input dialog after the editor is closed which allows users to modify the PR title and body.

This feature requires lots of complex changes and really challenging, thanks to @wangyantong2000 again.

@wangyantong2000 wangyantong2000 pinned this issue Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Category issues or prs related to feature request.
Projects
None yet
Development

No branches or pull requests

2 participants