alamion_obsidian-jira-sync/docs/template_example.md
Alamoin 0786db1535
Feats
- `Super Simple Time Tracker` plugin format support
- Support of multiple Jira connections.
- `AGENTS.md` file from Obidian plugin template and filled with info about project
- Updated eslint configs to `eslint.config.js` format + linted all the code; added prettier with according config
- localization validator improvement; multiple localization fixes
- many minor fixes
2026-04-29 17:41:24 +03:00

2.7 KiB

key status priority sprint epic link
JIR-1234 In Progress Medium Mobile-Q2-24 API-Overhaul http://jira.local:8000/browse/JIR-1234

Main Task Description

This is a comprehensive test file for the jira-sync parser.

Summary jira-sync-section-summary

Complete API standardization and consolidation across all microservices to improve developer experience and reduce integration complexity.

This section continues here with more details. Multiple paragraphs are supported.

Details Section

Customer Impact jira-sync-section-customfield_10842

The current API structure is too fragmented and requires standardization. Customers are experiencing difficulties integrating with our services due to:

  • Inconsistent authentication methods
  • Different response formats
  • Lack of versioning strategy

This impacts approximately 2,300 enterprise customers.

Next Heading Should Stop Section

This content should NOT be part of customfield_10842.

Assignment Info

Primary assignee: jira-sync-inline-start-assigneeJack A.M.jira-sync-end with backup from jira-sync-inline-start-assignee_backupSarah Chenjira-sync-end.

Reporter: jira-sync-inline-start-reporterMike Johnsonjira-sync-end

Time Tracking

Expected time spent on the task: jira-sync-line-originalEstimate1w 3d

Actual time logged so far: jira-sync-line-timeSpent2d 4h

Remaining estimate: jira-sync-line-remainingEstimate5d

Acceptance Criteria jira-sync-section-customfield_10100

  1. All endpoints follow RESTful conventions
  2. API versioning implemented via headers
  3. Consistent error handling across services
  4. OpenAPI 3.0 documentation published
  5. Migration guide for existing integrations

All criteria must be met before moving to Done.

Technical Requirements

This is a separate section that shouldn't be included above.

Code Block Examples

Here's a configuration block:

jira-sync-block-start-customfield_10500 { "apiVersion": "v2", "authentication": "OAuth2", "rateLimit": 1000 } jira-sync-end

And another block for database config:

jira-sync-block-start-customfield_10501 host: prod-db-01.internal port: 5432 database: api_gateway ssl: true jira-sync-end

Edge Cases Testing

Empty Inline

Status indicator: jira-sync-inline-start-status_indicator``jira-sync-end

Whitespace Heavy Section jira-sync-section-whitespace_test

This section has leading and trailing whitespace    

Should be trimmed properly before sending to Jira.

Single Line Section jira-sync-section-oneliner

Just one line here.

Multi-line Inline Test

Complex description: jira-sync-inline-start-description This is a description that spans multiple lines with various formatting jira-sync-inline-end and continues here.