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 docs to GitHub #27

Merged
merged 6 commits into from
Sep 8, 2022

Conversation

AayushSaini101
Copy link
Contributor

Migrate the docs of the plugin from the wiki Jenkins, and updated the porm.xml url

Copy link
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

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

This looks great! Thanks for doing it.

I'm happy to merge this pull request "as-is" and deliver a new release of the plugin so that the documentation is taken from the GitHub repository instead of the archived wiki.

Are you interested in splitting the changelog into a CHANGELOG.md so that the README only contains plugin documentation and not plugin history? That is a preparatory step for the step where the plugin switches to automatically generate its changelog based on pull request descriptions.

I'll need to update the "Contributing to Open Source" document and the Jenkins documentation to include that note, since I don't know if it is mentioned in any of those locations.

@AayushSaini101
Copy link
Contributor Author

This looks great! Thanks for doing it.

I'm happy to merge this pull request "as-is" and deliver a new release of the plugin so that the documentation is taken from the GitHub repository instead of the archived wiki.

Are you interested in splitting the changelog into a CHANGELOG.md so that the README only contains plugin documentation and not plugin history? That is a preparatory step for the step where the plugin switches to automatically generate its changelog based on pull request descriptions.

I'll need to update the "Contributing to Open Source" document and the Jenkins documentation to include that note, since I don't know if it is mentioned in any of those locations.

Sure sir, I will change it

@MarkEWaite
Copy link
Contributor

Also, don't forget to sync your fork each time you start the work on a new pull request.

screencapture-github-MarkEWaite-versionnumber-plugin-2022-09-08-10_35_28-edit

CHANGELOG.md Outdated Show resolved Hide resolved
read.md Outdated Show resolved Hide resolved
Copy link
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

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

Thanks so much!

@MarkEWaite MarkEWaite merged commit e4072e1 into jenkinsci:master Sep 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants