$ git checkout -b migrate-docs-to-github master
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 git branch for your local work with the command:
$ git checkout -b migrate-docs-to-github master
Follow the plugin documentation migration instructions.
Additional information is available from:
https://github.com/jenkins-infra/plugins-wiki-docs for plugin docs as markdown
https://github.com/jenkins-infra/confluence-data for entire wiki site as HTML
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:
remote: Create a pull request for 'migrate-docs-to-github' on GitHub by visiting:
remote: https://github.com/user/your-plugin/pull/new/migrate-docs-to-github
remote:
To github.com:user/your-plugin.git
* [new branch] migrate-docs-to-github -> migrate-docs-to-github
Branch 'migrate-docs-to-github' tracking remote branch 'migrate-docs-to-github'.
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.