microsoft / azure-pipelines-jira

Azure Pipelines for Jira
MIT License
15 stars 6 forks source link

Update documentation #38

Open sefi-jwilliams opened 4 years ago

sefi-jwilliams commented 4 years ago

Describe the bug There are references in the documentation to features that don't exist. Please update the README and tutorial files to not mention things that do not exist. Also, the supported/unsupported list at the end of the tutorial.md should be moved to the readme.md

To Reproduce Steps to reproduce the behavior:

  1. Go to 'https://github.com/microsoft/azure-pipelines-jira/blob/master/README.md'

  2. This statement is FALSE: "Azure Pipelines integration with Jira connects the two services, providing full tracking of how and when the value envisioned with an issue is delivered. Using the integration, teams can setup a tight development cycle from issue creation through release. Key development milestones for an issue can be tracked from Jira."

  3. Image below it says "Track entire development cycle..." This is FALSE. Only works on v1 pipelines which are classified as "releases" .

  4. " Associated Jira issues can also be viewed in builds and releases for a complete deployment history per environment." FALSE - remove "builds", reword "complete deployment" (testing environments may be done in prior stages to "release")

  5. Add link to tutorial.md in the README , so people can find it easier when trying to decide not to use this tool.

  6. Go to 'https://github.com/microsoft/azure-pipelines-jira/blob/master/tutorial.md'

  7. "FAQs" section should be moved to the README.md

Desktop (please complete the following information):

Smartphone (please complete the following information):