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

Update docs structure for website versioning improvements #3150

Merged
merged 21 commits into from
Jan 21, 2025

Conversation

thomas-bc
Copy link
Collaborator

Related Issue(s)
Has Unit Tests (y/n)
Documentation Included (y/n)

Change Description

Updating docs structure and mkdocs.yml a lot. This comes with the following improvements

  • Top level contents are not being versioned anymore (e.g. https://fprime.jpl.nasa.gov/events which could cause lots of confusion if old versions of it were still being shown)
  • Versioning is restricted to the source/docs folders
  • Entire fprime/ folder is being hosted on the website, major improvement in cross-linking capability (all relative links within the repo resolve correctly on the website, for example in SDDs linking to other docs).
  • Other misc improvements, such as adding a "Display source" button on each page that will take you to the source on the website.

Testing/Review Recommendations

These changes are currently live on https://fprime.jpl.nasa.gov

Future Work

Re-establish internal CI which was disabled while testing this

Copy link
Collaborator

@LeStarch LeStarch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@thomas-bc thomas-bc merged commit 6f1369b into nasa:devel Jan 21, 2025
36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants