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

Restructure docs for new website #3036

Merged
merged 53 commits into from
Dec 6, 2024
Merged

Restructure docs for new website #3036

merged 53 commits into from
Dec 6, 2024

Conversation

ashleynilo
Copy link
Collaborator

@ashleynilo ashleynilo commented Nov 21, 2024

Related Issue(s) F Prime Website Refresh
Has Unit Tests (y/n) n
Documentation Included (y/n) n (documentation is in the internal JPL repo with custom pages)

Change Description

  • Major restructure of the website information architecture based on the diataxis method and to make room for new, informational pages on F Prime. The key categories now are
    • Home
    • Overview
    • Getting Started
    • Documentation
      • Tutorials
      • User Manual
      • How To
      • Reference
    • Support
    • Events
  • Added new markdown files that include a link to the custom HTML templates and a link to that page on the website for the user to view. Custom pages are not viewable via the public F Prime GitHub repository
  • Added new high-level overview pages for each documentation topic (Tutorials, User Manual, How To, and Reference)
  • Removed _data and _includes folders and the files inside them since MkDocs have its own built-in navigation and table of contents
  • Removed _config.yml since MkDocs has its own config file
  • Updated headings of ALL files so that there’s only one H1 as the title of the page, adjusting the remaining headings as needed so that headings aren’t skipped
  • Renamed some folders and pages to only use all lowercase and hyphens
    Updated links throughout all of the pages to match the new information architecture
  • Using improved GitHub-style notes (e.g. > [!NOTE]) for pretty display
  • Minor grammar/typo changes

Rationale

Refreshed the F Prime Website to use the MkDocs documentation framework with the Material for MkDocs theme. Along with the new framework the site will now be fully accessible via https://fprime.jpl.nasa.gov/. Many items in the fprime/docs folder have been restructured to fit the MkDocs framework and is also based on the diataxis method with research from the JPL Human Systems Integration group.

Testing/Review Recommendations

Major changes are mainly within the new structure of the files. Please check for any broken links or any content/files that may have been unintentionally removed or set to a certain heading hierarchy.

Future Work

None at the moment.

@thomas-bc thomas-bc changed the title Docs/new website Restructure docs for new website Nov 21, 2024
@thomas-bc
Copy link
Collaborator

Closing for now as we are still in dev process so this is triggering CI too often. Will reopen when we're ready for review

@thomas-bc thomas-bc closed this Nov 21, 2024
@thomas-bc thomas-bc closed this Nov 26, 2024
@thomas-bc thomas-bc mentioned this pull request Dec 2, 2024
@thomas-bc thomas-bc reopened this Dec 4, 2024
@thomas-bc
Copy link
Collaborator

thomas-bc commented Dec 4, 2024

TODO:

  • Lock docs/auto-documentation branch to make sure no changes are going in
  • [ ]

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.

Website looks nice, content was approved by release authority, and @thomas-bc says we are ready.

Copy link
Collaborator

@thomas-bc thomas-bc left a comment

Choose a reason for hiding this comment

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

🎉
🚀

@thomas-bc thomas-bc merged commit 9367a3b into devel Dec 6, 2024
39 checks passed
@thomas-bc thomas-bc deleted the docs/new-website branch December 10, 2024 19:38
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