Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare action inputs for several high level features and regimes #57

Open
miroslavpojer opened this issue Oct 23, 2024 · 0 comments · May be fixed by #72
Open

Prepare action inputs for several high level features and regimes #57

miroslavpojer opened this issue Oct 23, 2024 · 0 comments · May be fixed by #72
Assignees
Labels
breaking change Introduces change, that is incompatible with last release enhancement New feature or request

Comments

@miroslavpojer
Copy link
Collaborator

Background

There are several features planned

  • Complex Living documentation ==> target Top Menu Living Doc
    • Feature issues mining
      • DocumentedFeatures & ?Topic labels expected (Allows isolated repo and normal functionality)
    • User Story issues mining
      • DocumentedUserStory & ?Topic labels expected (Allows isolated repo and normal functionality)
    • Requirements issues mining
      • DocumentedRequirement & ?Topic labels expected (Allows isolated repo and normal functionality)
  • Workflow (yml) files mining ==> target Top Menu CI jobs
    • no issue related
    • a special regime of liv-doc generator => solo step run in CI to collect outputs
  • Release notes mining ==> target Top Menu Releases
    • no issues related
    • a special regime of liv-doc generator => solo step run in CI to collect outputs
  • Incident issues mining ==> target Top Menu Incidents
    • development repositories and project related

Note: Complex Living Documentation could provide additional Top Menu items (Vision):

  • Coverage Matrix ==> complex matrix tables presenting coverage of User Stories, Features, and Requirements by tests.

Feature

  • Propose and implement inputs to allow the control regimes described above.
    • Keep proposal for not exiting regimes.
    • Implement the changes for existing ones - to allow future compatibility.
  • All regimes have to be able to run in isolation.
  • All regimes should be able to run in one call.
    • Input regime controls - enable/disable. Complex liv-doc is enabled by default, while rest is disabled.
      • Provide a proposal on controlling all three types in complex liv-doc as they should not be supported altogether.
    • Remove the current single output and define more of them by the regime.
@miroslavpojer miroslavpojer added the enhancement New feature or request label Oct 23, 2024
@MobiTikula MobiTikula self-assigned this Nov 18, 2024
@miroslavpojer miroslavpojer added the breaking change Introduces change, that is incompatible with last release label Nov 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Introduces change, that is incompatible with last release enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants