Migrate docs to GitHub

Jenkins plugin documentation was originally maintained on a wiki. The wiki was deprecated in 2019 due to spam and was shut down in 2021. Plugin documentation is migrating to GitHub. Instructions are available on the www.jenkins.io site.

Create a branch

In a local copy of your fork of the plugin repository create a git branch for your work with the command:

git checkout -b migrate-docs-to-github master

Migrating from Wiki to GitHub

Additional references

Additional information is available from:

Create a pull request

Commit that change:

git add README.md docs/images/ pom.xml
git commit -m "Migrate documentation to GitHub"

Push the change to GitHub:

git push origin --set-upstream migrate-docs-to-github
Total 0 (delta 0), reused 0 (delta 0), pack-reused 0
remote: Create a pull request for '{task-identifier}' on GitHub by visiting:
remote: https://github.com/user/your-plugin/pull/new/{task-identifier}
To github.com:user/your-plugin.git
 * [new branch]      {task-identifier} -> {task-identifier}
Branch '{task-identifier}' tracking remote branch '{task-identifier}'.

Notice that the output of the command includes the URL, which can be used to open a pull request. Copy that URL in your web browser and submit a pull request.