How to add technical documentation which is integrated with JIRA.

Tarek Faham October 18, 2018

JIRA Enhancements Tickets are used to track user requirements and status of the development work. It makes a lot of sense to link such tickets to related technical documentation, so that when you search, you get results related to Requirements, Development Progress, as well as related changes in the code/Database.

For example, I want to indicate what are the major changes that happened, which program part are affected, and on which server (the host of the source-code). The data entry for such information could be text based and manual. Meaning, it is not necessary that there is a direct soft-link to the back-end source code using a browse button, which will actually connect to SVN (source code repository) for example.

We are using Adobe LiveCycle Server/Workbench/Designer, and the code repository and source code control features are very primitive, and don't work well most of the times. 

We need simple approach to link JIRA Tickets with related technical documentation such as the Server, Application, Folder, Source Code Filename, Function Name, and Variable Names. Also, link the related Database details such as Server, DB Name and Table/Field Details.

What I mean by linking, is adding text to indicate relation to the source-code and Database. Eventually, I might want to get report about affected program parts over that past sprint. This is text based information, and doesn't have to be 100% accurate. Or, find out when a certain table was referenced or modified due to development work and what are the related tickets. See snapshot below to clarify the idea. The Highlighted parts, are the information needed to be linked to JIRA Ticket. 

Also, same thing applies if we use complex source code control like SVN with Eclipse. The system is so complex that it will be hard to find such information when browsing JIRA. We need something similar also when working with Eclipse/SVN or similar platforms.

Appreciate your help and reply.

Tarek

Adobe LiveCycle Workbench Source Code-trn.png

2 answers

0 votes
Tarek Faham September 29, 2021

Using vs code with BitBucket and Jira extensions did the trick. Thanks a lot.

0 votes
Gonchik Tsymzhitov
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
February 9, 2019

Hi! 

If I were I will try play with gitignore file and review the Adobe LiveCycle

Also, ping Adobe for the understand the situation of metadata etc.

 

Cheers,

Gonchik Tsymzhitov

Tarek Faham September 29, 2021

I am on a new role, and I found what I am looking for... however, it is with vs code and BitBucket Extensions. You can link the code to Jira Issues, and vise versa. This is really awesome! I tried that with a JavaBean project, and it worked like a charm.

I think with Adobe LiveCycle, if the developer can manage to open the project artifacts with VS Code and use BitBucket, then the problem maybe partially solved.

Good luck for Adobe LC Developers though.

Tarek

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events