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

Autogenerate Better Release Documentation #2653

Open
LeStarch opened this issue Mar 28, 2024 · 3 comments
Open

Autogenerate Better Release Documentation #2653

LeStarch opened this issue Mar 28, 2024 · 3 comments
Assignees
Labels
CI Issues pertaining to Continuous Integration Documentation Documentation, Tutorials and References updates High Priority High Priority issue that needs to be resolved.

Comments

@LeStarch
Copy link
Collaborator

F´ Version
Affected Component

Feature Description

Need to autogenerate release documentation.

@LeStarch LeStarch self-assigned this Mar 28, 2024
@LeStarch LeStarch added the High Priority High Priority issue that needs to be resolved. label Mar 28, 2024
@capsulecorplab
Copy link
Contributor

@thomas-bc
Copy link
Collaborator

thomas-bc commented Mar 29, 2024

Adding some context:

The way we have our documentation versioned is with version folders (3.0.0, 3.1.0 etc.) in our docs branch here: https://github.com/nasa/fprime/tree/docs/auto-documentation/docs
And then exposed here https://nasa.github.io/fprime/

Generating these versioned docs is a manual process, through a couple of scripts in the docs/ folder.

The scope of this ticket is to automated that process.

Although we're currently in an effort to revisit the way we serve documentation, so the result of that effort might affect this issue.

Also see #2635 - there is some insight about versioning in there

@thomas-bc thomas-bc added Documentation Documentation, Tutorials and References updates CI Issues pertaining to Continuous Integration and removed enhancement labels Mar 29, 2024
@LeStarch LeStarch assigned ashleynilo and unassigned ashleynilo and LeStarch Apr 1, 2024
@LeStarch
Copy link
Collaborator Author

LeStarch commented Apr 1, 2024

@ashleynilo assigned to you because you are working on the whole webpage rework task! I don't expect you to do this work, so much as track it so we can revisit once we have a new setup.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Issues pertaining to Continuous Integration Documentation Documentation, Tutorials and References updates High Priority High Priority issue that needs to be resolved.
Projects
None yet
Development

No branches or pull requests

4 participants