Use Cases
Combine GitHub data with other sources
Synchronize and link data from GitHub with self-written needs or needs imported from systems like CodeBeamer or GitHub.
Get a single document of truth for your overall project data.
Publish specific data for external access
Use Galaxy to create subsets of information for users and organizations, which should not have access to an internal GitHub instance. For instance extract specifications for suppliers, without any internal information.
Create Baselines and Archives
Galaxy can be used to create baselines of data from GitHub at a particular date. E.g. create a list of all open bugs at the release date. And archive the generated documentation to be compatible with ISO26262 and other safety standards.
Customized, combined views
Sphinx-Needs and Galaxy can be used to create project and user specific views on your data. This gets especially helpful when the shown data contains information from additional systems like CodeBeamer or GitHub.
Features
Sphinx-Needs Galaxy
- Create needs objects based on elements from GitHub.
- Filter and manipulate data during import.
- Map different data elements from Sphinx-Needs and GitHub together. E.g. Assignee -> Developer
- Customize content and replace values automatically. E.g. done -> closed
- Retrieve data during build or by script gh2needs.
- Update selectable elements in GitHub
via script
needs2gh.
Sphinx-Needs
- Present imported data in tables, flowcharts, pie charts and more.
- Link imported data from GitHub with needs from other systems like CodeBeamer or GitHub
- Automatically by using dynamic fields
- Manually by using needextend
- Extend imported needs with custom data by using needextend.
- Export all data and information to json-files.
All connectors
Sphinx-Needs
Capri
for
CodeBeamer
Synchronize data from CodeBeamer and get issues from trackers into your documentation.
Sphinx-Needs
Jade
for
JIRA
Synchronize data from JIRA and get any kind of issue into your documentation.
Coming soon!
Sphinx-Needs
Galaxy
for
GitHub
Synchronize data from GitHub and get issues and even pull requests into your documentation.
Coming soon!
Sphinx-Needs
Aero
for
Azure Boards
Synchronize data from Azure Boards and get issues into your documentation.
Coming soon!