integration-docs: Update the screenshot path of Jira plugin #869
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It was previously using the path corresponding to the directory name on
python-zulip-api
(jira
). It's now updated to use the name as used in the zulip/zulip repository.This PR is intended to be merged only after #34782.
Follow-up: Once this PR is merged, we should remove the exclusion added to
test_integration_doc_endpoints
inzulip/zulip
'stest_docs.py
.A previous version of the PR also updated Mercurial's
hg/001.png
->mercurial/001.png
, but I've since removed it, because of the hassle of tests failing whenever the images and docs are not in sync. So, I just addedimage_dir
to point tohg
inintegrations.py
.It is unavoidable for the Jira plugin though, because
jira/001.png
is being used by the Jira webhook integration. And there's a difference in the template format used, between the webhook and plugin integrations. We could consider using the same image for both the integ docs only if we test and upate them both to use the same message formats.Screenshots
Jira-plugin - before


Jira-plugin - after
How did you test this PR?
Self-review checklist
(variable names, code reuse, readability, etc.).
Communicate decisions, questions, and potential concerns.
Individual commits are ready for review (see commit discipline).
Completed manual review and testing of the following: