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

Migrate documentation from wiki if needed #23

Open
basil opened this issue Aug 18, 2023 · 0 comments
Open

Migrate documentation from wiki if needed #23

basil opened this issue Aug 18, 2023 · 0 comments
Labels
recipe Requests for new automated code changes

Comments

@basil
Copy link
Contributor

basil commented Aug 18, 2023

If the plugin's <url> starts with http://wiki.jenkins-ci.org/display/JENKINS/ then its documentation needs to be migrated from the old wiki. This is a bit of a laborious process and I am not sure it can be fully automated. The steps are, roughly:

  • Change the URL to <url>https://github.com/jenkinsci/${project.artifactId}-plugin</url>, unless of course the artifact ID is different from the GitHub repository.
  • Fetch the wiki page from https://github.com/jenkins-infra/plugins-wiki-docs/ and split it from a single page into a README.md page and a CHANGELOG.md page. These files notoriously contain non-ASCII characters, so best to also do some Unicode normalization here.
  • If the wiki export contains images, copy them from there to docs/images/.
  • If the plugin is now using Release Drafter, add a note to CHANGELOG.md saying that future change logs are available at the GitHub releases page rather than in CHANGELOG.md.
@timtebeek timtebeek moved this to Recipes Wanted in OpenRewrite Aug 18, 2023
@timtebeek timtebeek added the recipe Requests for new automated code changes label Aug 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
recipe Requests for new automated code changes
Projects
Status: Recipes Wanted
Development

No branches or pull requests

2 participants