Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

integration-docs: Update the screenshot path of Jira plugin#869

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
Niloth-p wants to merge1 commit intozulip:main
base:main
Choose a base branch
Loading
fromNiloth-p:doc-image-paths

Conversation

Niloth-p
Copy link
Contributor

@Niloth-pNiloth-p commentedJun 1, 2025
edited
Loading

It was previously using the path corresponding to the directory name onpython-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 totest_integration_doc_endpoints inzulip/zulip'stest_docs.py.

A previous version of the PR also updated Mercurial'shg/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, becausejira/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
image
Jira-plugin - after
image

How did you test this PR?

Self-review checklist
  • Self-reviewed the changes for clarity and maintainability
    (variable names, code reuse, readability, etc.).

Communicate decisions, questions, and potential concerns.

  • Explains differences from previous plans (e.g., issue description).
  • Highlights technical choices and bugs encountered.
  • Calls out remaining decisions and concerns.
  • Automated tests verify logic where appropriate.

Individual commits are ready for review (seecommit discipline).

  • Each commit is a coherent idea.
  • Commit message(s) explain reasoning and motivation for changes.

Completed manual review and testing of the following:

  • Visual appearance of the changes.
  • Responsiveness and internationalization.
  • Strings and tooltips.
  • End-to-end functionality of buttons, interactions and flows.
  • Corner cases, error conditions, and easily imagined bugs.

It was previously using the path corresponding to the directoryname on `python-zulip-api` (`jira`). It's now updated to use the nameas used in the zulip/zulip repository.
@Niloth-pNiloth-p changed the titleintegration-docs: Update the example screenshot image paths.integration-docs: Update the screenshot path of Jira pluginJun 1, 2025
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

2 participants
@Niloth-p@zulipbot

[8]ページ先頭

©2009-2025 Movatter.jp