Wiki redirects, wiki exporter, and plugin changelogs

87 views
Skip to first unread message

Mark Waite

unread,
Feb 7, 2020, 8:56:19 AM2/7/20
to Jenkins Developers
Gavin Mogan has made significant improvements to https://plugins.jenkins.io/ .  It loads faster, works better, and is easier to maintain.  Thanks Gavin!

As part of those improvements, plugin pages on the Jenkins wiki are now automatically redirected to https://plugins.jenkins.io/ .  For example, the wiki page that would previously have opened for https://wiki.jenkins.io/display/JENKINS/Git+Plugin now redirects to https://plugins.jenkins.io/git .  The new page loads much faster and is more easily and reliably maintained in the plugin repository.

Only plugin pages on the wiki are automatically redirected.  Other pages on the Jenkins wiki are not automatically redirected.  As we move documentation from the wiki to https://jenkins.io/doc/, more wiki pages will be redirected.

Because the Jenkins wiki is read only, plugin maintainers will need to move their documentation the next time they update it.  Plugin documentation preferences are:
Plugins that have not migrated their documentation from the wiki to GitHub will continue to show that documentation on https://plugins.jenkins.io/ .  Wiki based documentation can't be edited due to the spam problems which forced us to make the Wiki read-only.

Plugin developers that aren't ready to transition to automatic changelogs could migrate their changelog from wiki to GitHub CHANGELOG.md file using wiki exporter and continue to maintain the changelog manually.

Deepest and most sincere thanks to Gavin Mogan for his excellent work on the transition of plugin documentation from Wiki to GitHub!  Thanks also to Tim Jacomb, Oleg Nenashev, and many others for their efforts to make the transition successful.  Over 250 plugin repositories have already completed the transition from Wiki documentation to maintaining their documentation in GitHub.

Mark Waite

Olblak

unread,
Feb 7, 2020, 9:12:39 AM2/7/20
to Jenkins Developers ML
Indeed congrats to everybody, this sub-project is a beautiful example of contributing to an OSS project is not only about write code for the application itself but also improving its ecosystem through collaboration.

---
gpg --keyserver keys.gnupg.net --recv-key 52210D3D
---
--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-de...@googlegroups.com.

Tim Jacomb

unread,
Feb 7, 2020, 10:37:07 AM2/7/20
to jenkin...@googlegroups.com
If anyone wants to help out there’s a progress page here:

Pick one that isn’t in progress,
Use the wiki exporter to get all content and images, 
Do a bit of cleanup
Open a pull request 
Add your pull request to the GitHub project tracking it (
https://github.com/orgs/jenkinsci/projects/3), I think any org member can do it, and if you can’t do it then ask in the gitter channel 

The progress page is automatically updated based on the GitHub project

Thanks
Tim

Arnaud Héritier

unread,
Aug 6, 2020, 4:41:19 PM8/6/20
to Jenkins Developers
Hi team,

What is the status today ?

I wanted to convert the doc for https://plugins.jenkins.io/pipeline-maven/

Error: TypeError: Failed to fetch  

Both with the wiki URL and the plugin ID with options:
  • Markdown Zip  
  • Asciidoc  
  • Asciidoc Zip
Only the Markdown output works. Is it a known issue ? A problem specific to this (large) page ?

I cannot use the manual version too because to display the html export of a page we need its ID not its name


Any hint ?

To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CAH-3Biei_FT_SgubSgUiQ8dRtYFCYmOTCiZd%3DLuXm-%2BA0fD11A%40mail.gmail.com.


--
Arnaud Héritier
Twitter/Skype : aheritier

Gavin Mogan

unread,
Aug 6, 2020, 4:50:40 PM8/6/20
to Jenkins Developers
The code currently looks for the pageId inside of the output of the url. the viewpagesource link requires a login. Right. It doesn't actually care about pageId anymore cause the apis returned different results than the rendered page.
Whats the actual url to that wiki page? can you try that one instead of the viewpagesrc link which requires login and admin access?

To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CAFNCU-8Hfy-c93%3DpZWQT3yhXG_SV-yx6d0XSzzwLSa-AJhxW_A%40mail.gmail.com.

Arnaud Héritier

unread,
Aug 6, 2020, 5:29:46 PM8/6/20
to jenkin...@googlegroups.com
Hi Gavin

The wiki url is 

But it doesn’t work

I can still login in our wiki (as user not admin I think) but because of the redirect I cannot display the HTML or find its ID. 

I can probably find it in the DB with my infra access but it’s a bit extreme 

Gavin Mogan

unread,
Aug 6, 2020, 5:56:09 PM8/6/20
to Jenkins Developers
https://files.halkeye.net/jenkins/https __wiki.jenkins-ci.org_display_JENKINS_Pipeline+Maven+Plugin.adoc.zip
https://files.halkeye.net/jenkins/https __wiki.jenkins-ci.org_display_JENKINS_Pipeline+Maven+Plugin.md.zip

My local dev instance works fine. I'm guessing that wiki page just has too much content and the page times out? if more people are having the issue, we can open an infra ticket to give it more resources.

On Thu, Aug 6, 2020 at 2:49 PM Gavin Mogan <ga...@gavinmogan.com> wrote:
I don't know why the zips arn't working (which include assets), but both non zips work fine (attached)

To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CAFNCU-_Nx1cAXDL2TTgP1hKLW1A5egwpSt1KVitjdxUumqT%2Bng%40mail.gmail.com.

Gavin Mogan

unread,
Aug 6, 2020, 6:14:33 PM8/6/20
to Jenkins Developers
I don't know why the zips arn't working (which include assets), but both non zips work fine (attached)

To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CAFNCU-_Nx1cAXDL2TTgP1hKLW1A5egwpSt1KVitjdxUumqT%2Bng%40mail.gmail.com.
mavenplugin.md.txt
mavenplugin.adoc.txt

Arnaud Héritier

unread,
Aug 6, 2020, 6:17:44 PM8/6/20
to jenkin...@googlegroups.com
Great. Thanks a lot Gavin. I will download them tomorrow. 

Mark Waite

unread,
Aug 6, 2020, 11:58:41 PM8/6/20
to jenkinsci-dev
I was able to see a similar behavior on another large plugin page that hasn't yet been converted.   https://plugins.jenkins.io/prqa-plugin/ is the sample plugin that I saw fail.

To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CAFNCU-8EYtuFUeXp7ooAZTwXNUab_WMSMhB05p-nKQagKEy0zw%40mail.gmail.com.

Arnaud Héritier

unread,
Aug 7, 2020, 1:17:17 AM8/7/20
to Jenkins Developers
It's all good for me Gavin.
I downloaded the files, it will help me a lot to convert them

I hope we don't have too many big pages like this one but maybe like you say, it's the timeout to increase. For this plugin it has to build a 2Mb archive and I the processing time is perhaps too long globally
Reply all
Reply to author
Forward
0 new messages