Skip to end of banner
Go to start of banner

Using Jira to manage work for docs.folio.org

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Review the upcoming release to help figure out what might need to be added to or changed in documentation

There are various ways to review changes, you should consider doing them all, depending on how your particular area of FOLIO typically shares information.

  • Ask product owners to share with you what features are planned for the upcoming release. Product owners are listed by module at FOLIO Module/JIRA project-Team-PO-Dev Lead responsibility matrix
  • Review the release notes. Product owners update release notes at various times, so just because something is not on the release notes doesn't mean it isn't happening in the release, but you can be assured that if something is listed in the release notes, it can be expected to appear in the release, barring discovery of unexpected bugs.
  • Review jiras assigned to the specific release. In Jira, you can search for issues that are assigned to a specific release. From the issue search, add the "Release" criteria from the more menu, and then choose the release you are working on from the check box. For some areas of FOLIO, it's helpful to also choose from the Project menu to narrow the list down further. EG, you can choose the UXPROD project to just search for new features in a release and not also see bugs or tech debt or other work happening that doesn't necessarily need documentation.

Create a DOCS Jira for each discrete piece of documentation you need to do

Once you have an idea of what changes need to be made, you can then create jiras for them. Various folks have organized their docs jiras in different ways, but in general it is helpful to create a DOCS Jira for each new feature you need to review for documentation, or for new bugs or workflow changes. It's much less helpful to just have, say, one Jira for "Poppy RA Work".

To create a DOCS jira:

  1. Make sure you are logged into the FOLIO Jira (https://issues.folio.org)
  2. From the top menu, click "Create"
  3. The Create Issue box appears in the middle of the screen. From the Project List, choose FOLIO Documentation (DOCS)
  4. From Issue type, choose Task

  • No labels