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

Jira subscriptions modal needs explanation in the docs #830

Closed
mickmister opened this issue Jan 13, 2022 · 2 comments · Fixed by #904
Closed

Jira subscriptions modal needs explanation in the docs #830

mickmister opened this issue Jan 13, 2022 · 2 comments · Fixed by #904
Labels
Docs/Needed Requires documentation

Comments

@mickmister
Copy link
Contributor

The Jira plugin docs show a picture of the channel subscriptions modal here, but there's no explanation of how to use the subscriptions modal.

At the moment, the frontend shows an "approximate JQL query" which reveals a lot of what the tool can do, but it's not obvious how it works. The docs seem like the right place to explain this. We can link to the docs from the frontend, and asynchronously update the docs.

@Nityanand13
Copy link
Contributor

@mickmister Can you please explain the last line that you have written in the description of this issue?

We can link to the docs from the frontend, and asynchronously update the docs.

@mickmister
Copy link
Contributor Author

@Nityanand13 What I mean is that if we link to the docs in the UI, we don't need to edit the UI source code to update an explanation of the feature. Linking to the docs is a "one and done" task, and we can continuously iterate on the actual docs, and it will automatically be "updated" in the UI since the information is not actually in the UI.

@hanzei hanzei linked a pull request Jan 24, 2023 that will close this issue
@mkdbns mkdbns moved this from Todo to Submitted in Brightscout Plugin Maintenance Apr 28, 2023
mickmister pushed a commit that referenced this issue Jan 18, 2024
* [MI-2608]: Explained the jira subscription modal in the doc. (#31)

* [MI-2608]: Explained the jira subscription modal in the doc.

* [MI-2608]:Review fixes done
1. Modified the doc
2. Connected the doc from frontend

* [MI-2608]: Review fixes done
1. Modified the administrator guide doc

* Fixed CI errors

* [MI-2698]: Review fixes done of PR #904 (#33)

* [MI-2698]: Review fixes done of PR #904

* [MI-2698]: Review fixes done
1. Improved the content of a administrative guide doc

* [MI-2799]: Done review fixes of Jira PR #904 (#38)

* Fixed CI errrors

* [MM-830] Remove extra file

* [MM-830] Update snapshot

* [MM-830] Remove extra parameter from link

* [MM-830] Update snapshot

---------

Co-authored-by: ayusht2810 <ayush.thakur@brightscout.com>
Co-authored-by: raghavaggarwal2308 <raghav.aggarwal@brightscout.com>
@github-project-automation github-project-automation bot moved this from Submitted / In Review to Done in Brightscout Plugin Maintenance Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs/Needed Requires documentation
Projects
Development

Successfully merging a pull request may close this issue.

2 participants