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

Add edit this page link #556

Open
timja opened this issue Jan 1, 2021 · 11 comments
Open

Add edit this page link #556

timja opened this issue Jan 1, 2021 · 11 comments

Comments

@timja
Copy link
Member

timja commented Jan 1, 2021

We currently have:

Help us improve this page!
To propose a change submit a pull request to the plugin page on GitHub.

It would be good to add an 'Edit this page' or 'Improve this page' link next to report a problem so you can go directly to the GitHub edit page screen from the plugin site

@Chandu-4444
Copy link

Chandu-4444 commented Jul 27, 2021

Can I do this? @timja

@zbynek
Copy link
Contributor

zbynek commented Jul 28, 2021

if the goal is just to have the same link in two places, this should be quite straightforward. If we want the actual link for editing the readme, the hard part is to figure out which file it is -- it may be README.md / README.txt / README.adoc, not sure how to efficiently get it from GitHub API. Also at the moment all queries to GH API are in the plugin-site-api repository.

@RiyaGupta89
Copy link

@zbynek May I work on this issue?

@halkeye
Copy link
Member

halkeye commented Oct 2, 2021

Sure, let us know if you need a hand or unable to work on it

@zbynek
Copy link
Contributor

zbynek commented Oct 2, 2021

@timja do you have any idea how to get the correct link from GitHub API?

@timja
Copy link
Member Author

timja commented Oct 2, 2021

@Harsh3341
Copy link
Contributor

Any update on this issue?

@halkeye
Copy link
Member

halkeye commented Jun 3, 2023

what update are you expecting?

@Harsh3341
Copy link
Contributor

The implementation part is it needs to be done?
This issue is been old just asking if it's necessary to work on it.

@zbynek
Copy link
Contributor

zbynek commented Jun 4, 2023

It's still a valid issue, IMHO not a high priority though.

The question is how to best find location of the README in repository. It's possible to do that with rest API, but that means 1 request per repository. Since plugin-site repo doesn't have credentials for GitHub API that would have to be exposed through API of some other component, such as https://github.com/jenkins-infra/docker-plugin-site-issues . One could ask GitHub developers to add it to the GraphQL API so that it can be obtained for 100 repos in one query. Or just try the 2-4 most common locations. Currently #961 implements the last approach.

@nouralmulhem
Copy link
Contributor

is this still to be done? if so let me know where i can found Help us improve this page!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants