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

Add images to improve docs clarity #900

Merged
merged 3 commits into from
Jun 8, 2020

Conversation

MarkEWaite
Copy link
Contributor

@MarkEWaite MarkEWaite commented Jun 6, 2020

Add images to improve docs clarity

The images provide more context for the reader. They help the reader confirm that the screen they are seeing in their running Jenkins instance is similar to the screen being documented.

Accepts that the conversion from tables to divs will justify revising all these screenshots, but that is not likely to arrive in an LTS for at least 3 months.

Review in context in the pull request README , compare with the master branch README and with the plugins.jenkins.io version.

Checklist

  • I have read the CONTRIBUTING doc
  • I have referenced the Jira issue related to my changes in one or more commit messages
  • I have added documentation as necessary

Types of changes

  • New feature (non-breaking change which adds functionality)

The images provide more context for the reader.  They help the reader
confirm that the screen they are seeing in their running Jenkins instance
is similar to the screen being documented.

Accepts that the conversion from tables to divs will justify revising
all these screenshots, but that is not likely to arrive in an LTS for
at least 3 months.
@MarkEWaite
Copy link
Contributor Author

MarkEWaite commented Jun 6, 2020

Would like review from at least one person, but will merge even without reviews in a day or two. Even if there are mistakes, I'm confident that the documentation is more readable now than it was before.

@MarkEWaite MarkEWaite added the documentation Improvements or additions to documentation label Jun 6, 2020
@kshultzCB
Copy link
Contributor

I'll be able to look on Monday morning. :)

@MarkEWaite MarkEWaite mentioned this pull request Jun 8, 2020
10 tasks
@MarkEWaite MarkEWaite merged commit 2fdd6db into jenkinsci:master Jun 8, 2020
@MarkEWaite MarkEWaite deleted the add-images-to-docs branch June 8, 2020 21:36
@kshultzCB
Copy link
Contributor

I actually missed my window by 19 seconds. But this LGTM. More screenshots are always great 👍

@MarkEWaite
Copy link
Contributor Author

Thanks for reviewing it @kshultzCB .

Next stop, the pipeline symbols work and then a beta release by end of this week. We're less than two weeks away from the release of 2.235.1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants