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

Remove wiki urls by rewriting them to github blobs #548

Closed
wants to merge 2 commits into from

Conversation

halkeye
Copy link
Member

@halkeye halkeye commented Sep 16, 2021

@daniel-beck daniel-beck self-requested a review September 16, 2021 06:29
@daniel-beck
Copy link
Contributor

daniel-beck commented Sep 18, 2021

Thanks! Are there plans to create the pages that are currently missing? These are the URLs in that repo that don't exist, introduced by this change:

https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/ColumnsPlugin/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/alauda-devops-credentials-provider/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/alauda-devops-pipeline/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/alauda-kubernetes-support/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/aqua-microscanner/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/aqua-serverless/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/autocomplete-parameter/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/aws-yum-parameter/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/behave-testresults-publisher/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/database-drizzle/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/devstack/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/dlisting-cov/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/dynatrace-dashboard/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/event-announcer/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/flexteam/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/h2-api/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/humbug/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/humio/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/ibm-continuous-release/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/ibm-security-appscansource-scanner/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/ikachan/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/jenkinspider/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/jna-posix-api/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/jnr-posix-api/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/jprt/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/jwt-support/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/kubesphere-token-auth/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/metrics-datadog/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/multi-branch-priority-sorter/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/mysql-api/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/network-monitor/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/non-dynamic-hello-world/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/pipeline-deploymon/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/pipeline-huaweicloud-plugin/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/pipeline-restful-api/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/pipeline-timeline/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/qc/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/rallyBuild/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/sealights/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/sourcemonitor/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/suite-test-groups-publisher/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/webhook-eventsource/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/working-hours/README.md
https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/wso2id-oauth/README.md

@daniel-beck daniel-beck added the enhancement This is an enhancement for the tool or wrapper scripts, typically adding features. label Sep 18, 2021
@halkeye
Copy link
Member Author

halkeye commented Sep 18, 2021

No concrete plans. Those are very hard to find.
For example https://github.com/jenkinsci/aqua-microscanner-plugin links to https://wiki.jenkins-ci.org/display/JENKINS/Aqua+MicroScanner+Plugin

 Page Not Found

We can't find that page. This could be because:

    The page doesn't exist.
    The page exists, but you don't have view permission for that space.

Site Search
Go to

    Site Homepage
    Your Dashboard

Web archive doesn't either

http://web.archive.org/web/*/https://wiki.jenkins-ci.org/display/JENKINS/Aqua+MicroScanner+Plugin

So each of those 2 dozen plugins would have to have a lot of manual digging around, and since they didn't work before, i'm not really concerned about this breaking things.

@zbynek
Copy link
Contributor

zbynek commented Sep 18, 2021

@halkeye @daniel-beck should we add an override for those to point to their GitHub repo? That can't make things worse... 🤷 I can create a follow-up PR for that.

@halkeye
Copy link
Member Author

halkeye commented Sep 18, 2021

I originally pulled the list exported by update center, so if they pointed to the right place I grabbed them - https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/export.js#L39

should we add an override for those to point to their GitHub repo? That can't make things worse... 🤷 I can create a follow-up PR for that.

🤦 I just realized as I was clicking around, https://github.com/jenkinsci/aqua-microscanner-plugin has a readme. I think the overrides are a good idea

@daniel-beck
Copy link
Contributor

@zbynek Ideally we'd file PRs first for such plugins, at least the ones somewhat actively maintained. Overrides are useful in the short term, but carrying them indefinitely is something we should try to not do.

@daniel-beck
Copy link
Contributor

@halkeye Can you access wiki page rename information, or is that something the exporter already supported? Or do we have a list of all wiki pages to look through for typo'ed / similarly named pages?

(Obviously the ROI here is quickly reached, so we shouldn't overdo it with the manual work.)

Affected plugins by popularity
1 dlisting-cov
3 non-dynamic-hello-world
4 humio
5 event-announcer
5 ikachan
6 flexteam
9 devstack
11 jenkinspider
15 suite-test-groups-publisher
17 ibm-continuous-release
18 jnr-posix-api
19 jprt
23 jna-posix-api
24 wso2id-oauth
33 sealights
34 alauda-devops-credentials-provider
35 humbug
36 kubesphere-token-auth
44 alauda-devops-pipeline
48 aqua-serverless
53 rallyBuild
61 ColumnsPlugin
77 jwt-support
79 alauda-kubernetes-support
85 pipeline-huaweicloud-plugin
108 ibm-security-appscansource-scanner
114 working-hours
133 database-drizzle
139 multi-branch-priority-sorter
149 aws-yum-parameter
184 behave-testresults-publisher
205 webhook-eventsource
218 dynatrace-dashboard
238 aqua-microscanner
245 qc
268 autocomplete-parameter
335 metrics-datadog
351 sourcemonitor
373 network-monitor
503 mysql-api
512 pipeline-deploymon
663 pipeline-restful-api
2546 pipeline-timeline
24003 h2-api

@zbynek
Copy link
Contributor

zbynek commented Sep 18, 2021

PR for h2-api was merged jenkinsci/h2-api-plugin#2 by @cyrille-leclerc, pipeliine-timeline was updated here jenkinsci/pipeline-timeline-plugin@74bd51e, pipeline-restful-api here jenkinsci/pipeline-restful-api-plugin@ed72eaa -- none of them released

@halkeye
Copy link
Member Author

halkeye commented Sep 18, 2021

@halkeye Can you access wiki page rename information, or is that something the exporter already supported? Or do we have a list of all wiki pages to look through for typo'ed / similarly named pages?

I have access to an offline copy and db dump. Its very slow. Lots of pages don't work cause of hostname rename (localhost vs wiki.jenkins).

I'll admit after 3 years to fix it, these are all ones that didn't bother to do it. I won't shed a tear if they stay broken.

I can try and figure out more when I get back from giving blood. I'll probably import the sql into my homelab and see what i can't find out from raw sql

@halkeye
Copy link
Member Author

halkeye commented Sep 21, 2021 via email

@daniel-beck
Copy link
Contributor

daniel-beck commented Sep 21, 2021

No, just waiting for me to have some time, no later than the weekend, probably earlier. How does this currently impact users? Since the site special-cases this already, I didn't get the impression this was urgent.

@halkeye
Copy link
Member Author

halkeye commented Sep 21, 2021

Nope. Plugin site has already been patched, I thought I was the blocker so wanted to check in before i archived the email

@daniel-beck daniel-beck self-assigned this Sep 21, 2021
Comment on lines 357 to +358
url = url.replace("http://wiki.jenkins-ci.org", "https://wiki.jenkins.io");
url = url.replace("https://wiki.jenkins-ci.org", "https://wiki.jenkins.io");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

url = url.replace("http://wiki.jenkins-ci.org", "https://wiki.jenkins.io");
->
url = url.replaceAll("(http|https)://wiki.jenkins-ci.org", "https://wiki.jenkins.io");

Comment on lines +359 to +361
if (url.startsWith("https://wiki.jenkins.io")) {
url = "https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/" + artifact.artifactId + "/README.md";
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if (url.startsWith("https://wiki.jenkins.io")) {
url = "https://github.com/jenkins-infra/plugins-wiki-docs/blob/master/" + artifact.artifactId + "/README.md";
}

Since this PR the wiki service has been restored, no need to redirect to github blobs.

@daniel-beck
Copy link
Contributor

Per @lemeurherve's comment, this no longer seems necessary or useful.

@daniel-beck daniel-beck removed their assignment Sep 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This is an enhancement for the tool or wrapper scripts, typically adding features.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants