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 documentation formatting #102

Merged
merged 1 commit into from
Jun 2, 2023

Conversation

MarkEWaite
Copy link
Contributor

@MarkEWaite MarkEWaite commented Jun 2, 2023

Improve documentation formatting

The examples were wider than necessary so that the reader would see a horizontal scroll bar in the examples. Examples can be word-wrapped comfortably so that the reader does not need to scroll horizontally to see the example.

Testing done

Reviewed in the GitHub file viewer

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

@MarkEWaite MarkEWaite added the documentation Documentation improvements label Jun 2, 2023
@MarkEWaite MarkEWaite enabled auto-merge (squash) June 2, 2023 14:47
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.

Looks good to me, thank you for that, Mark!

@MarkEWaite MarkEWaite merged commit 3c2f3f2 into jenkinsci:master Jun 2, 2023
@MarkEWaite MarkEWaite deleted the improve-docs-formatting 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