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

Improve README generator #108

Merged
merged 1 commit into from
Aug 10, 2023

Conversation

MarkEWaite
Copy link
Contributor

Improve README generator

Use generated README with one manual fix. The manual fix prevents a line from being too long in an example.

Testing done

Confirmed that the generated README contains only one change that is not workable. Generated README matches the checked in README except for that one change.

Submitter checklist

  • Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
  • Ensure that the pull request title represents the desired changelog entry
  • Please describe what you did
  • Link to relevant issues in GitHub or Jira
  • Link to relevant pull requests, esp. upstream and downstream changes
  • Ensure you have provided tests - that demonstrates feature works or fixes the issue

Use generated README with one manual fix.  The manual fix prevents a
line from being too long in an example.

Remove trailing white space from generated README.

Fix README generation instructions

Remove duplicate blank lines

Simplify javadoc for the README

Better id description
@MarkEWaite MarkEWaite added the documentation Documentation improvements label Aug 10, 2023
@MarkEWaite MarkEWaite enabled auto-merge (squash) August 10, 2023 05:31
Copy link
Contributor

@gounthar gounthar left a comment

Choose a reason for hiding this comment

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

Thank you, Mark. 👍

@MarkEWaite MarkEWaite merged commit 8385a24 into jenkinsci:master Aug 10, 2023
@MarkEWaite MarkEWaite deleted the improve-README-generation branch August 13, 2023 05:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants