Showing results for 
Search instead for 
Did you mean: 
Sign up Log in
It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Is allowed/standard to embed plugin's documentation in jar file?


We are developing a plugin and we'd like to provide embedded documentation for using it to final users (by including some web pages with instructions/troubleshooting sections or other guides), this because some of our customers do not have access to Internet on their facilities. We know we can always create some customized Jira menus, and retrieve this information from a velocity template but we were wonder whether there is a standard way to do this or it is not expected at all (considered a bad practice)? In this latter case, what should we do on our scenario where our customers cannot access our online help documentation because of their facilities restrictions?

0 answers

Suggest an answer

Log in or Sign up to answer
Community showcase
Published in Apps & Integrations

Send an Email or Publish to Confluence - What should you do with your release notes?

Background When you hear the words ‘Release notes’, almost always you think of an unsolicited email from a software vendor. But I am here to tell you that from our data, sending release notes via E...

136 views 1 2
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you