github.com/Racer159/jackal@v0.32.7-0.20240401174413-0bd2339e4f2e/docs/9-roadmap.md (about)

     1  ---
     2  sidebar_position: 9
     3  ---
     4  
     5  # Roadmap
     6  
     7  ## Issue Tracking
     8  
     9  The issue board for Jackal is hosted on a [GitHub Project Board](https://github.com/orgs/defenseunicorns/projects/1) that tracks the issues the Jackal team is working along with future work we are prioritizing.
    10  
    11  If you would like to add bug reports or feature requests, please [add an issue](https://github.com/Racer159/jackal/issues) to the GitHub repository under the appropriate template.  If you have a more general question about a feature, feel free to ask the team in the [Jackal Kubernetes Slack Channel](https://kubernetes.slack.com/archives/C03B6BJAUJ3).
    12  
    13  We also accept contributions from the community (regardless of where a particular bug or feature is in the queue), so feel free to read our [contributing guidelines](./12-contribute-to-jackal/1-contributor-guide.md) and [submit a PR](https://github.com/Racer159/jackal/pulls)!  You can also ask any development related questions in the [Jackal Dev Kubernetes Slack Channel](https://kubernetes.slack.com/archives/C03BP9Z3CMA).
    14  
    15  ## 2024 General Roadmap
    16  
    17  ### Q1: Community Building and Refactoring
    18  
    19  - [X] - Establish a [monthly community meetup](https://github.com/Racer159/jackal/issues/2202) to engage members of the community and answer questions.
    20  - [ ] - Refactor and add tests to library code shared with [UDS-CLI](https://github.com/defenseunicorns/uds-cli) and split into a new GitHub repository.
    21  - [ ] - Gather OpenSSF donation requirements and clear off pre-reqs (additional maintainers and sponsor working group).
    22  
    23  ### Q2 Consistency, Docs and Donation to OpenSSF
    24  
    25  - [ ] - Consolidate and improve consistency around features such as Jackal `variables` and component `required` schema.
    26  - [ ] - Move [docs website](https://docs.jackal.dev) from Docusaurus to a different framework to improve maintainability going forward.
    27  - [ ] - Finalize and submit Jackal's `sandbox` application to officially join the OpenSSF.
    28  
    29  ### Q3: Transfer Project, Stabilize and Extend
    30  
    31  - [ ] - Transfer project and additional repos (`jackal-ui`, `jackal-init-aws`, `setup-jackal`, etc.) to a new GitHub organization.
    32  - [ ] - Stabilize features after the consolidation of Q2 - clean up GA milestone in preparation for Q4.
    33  - [ ] - Flesh out the extension system for new features / experiments to be more smoothly integrated with Jackal.
    34  - [ ] - Make `jackal init` custom logic definable in-schema and across all packages.
    35  
    36  ### Q4: Post Donation and General Availability
    37  
    38  - [ ] - Continue stabilizing features and interfaces in preparation for GA release.
    39  - [ ] - Gather and prepare to meet OpenSSF's `incubation` requirements.
    40  - [ ] - Officially cut a GA v1.0.0 release of Jackal.
    41  
    42  ## Feature Stability
    43  
    44  Jackal has three levels of feature stability that are defined below but generally follow existing Kubernetes conventions.  These communicate how a feature may change in the future as well as expectations for [*ilities](https://en.wiktionary.org/wiki/ility) like documentation.
    45  
    46  ### `alpha`
    47  
    48  Alpha features act as early previews for things that are being considered for inclusion into Jackal and:
    49  
    50  - they are very likely to have breaking changes (or be removed entirely) in future versions of Jackal
    51  - they will have limited documentation beyond autogenerated CLI and schema documentation (questions should be directed to the [Jackal team](https://kubernetes.slack.com/archives/C03B6BJAUJ3))
    52  - they will have limited testing and are only recommended for use cases where the risk of instability is acceptable
    53  
    54  ### `beta`
    55  
    56  Beta features are newer features that are being prepared to eventually become stable features and:
    57  
    58  - they may introduce breaking changes before release, but will include any applicable workarounds
    59  - they will have documentation beyond autogenerated docs, but it won't be fully complete
    60  - they will have tests that cover their core features, but not covering every flavor of environment
    61  
    62  ### `stable`
    63  
    64  Stable features are features that the Jackal team has committed to maintaining stability for and:
    65  
    66  - they will have backwards compatibility shims introduced in lieu of breaking changes
    67  - they will have autogenerated docs, tutorials/tutorial mentions, examples, and core docs
    68  - they will have tests that cover the feature which will run across all tested environments
    69  
    70  :::note
    71  
    72  While Jackal is pre-General Availability (see below) the above feature stability guidelines should be considered notionally what our expectations are for different Jackal features.  There may be individual cases where *ilities are not met as we work to shore things up for GA.
    73  
    74  :::
    75  
    76  ## General Availability (GA) Release
    77  
    78  Right now, Jackal itself is still in its 'beta' phase. We are working on some final things before we release the official 1.0 General Availability (GA) release. The work still needed for the GA release can be found in our issues with [this filter](https://github.com/Racer159/jackal/issues?q=is%3Aopen+is%3Aissue+label%3Aga).
    79  
    80  We are currently targeting Q4 2024 to have Jackal be generally available and will be pushing weekly releases until then to add necessary features and fix bugs as well as improve docs, architecture and test coverage behind the scenes.