Combined into one page for MkDocs Website

[ashleynilo]

Change Description

• Combined all Math Component Tutorial files into one in the following order:
  • README.md
  • project-setup.md
  • defining-types.md
  • constructing-ports.md
  • creating-components-1.md
  • creating-components-2.md
  • creating-components-3.md
  • creating-components-4.md
  • developing-deployments.md
  • writing-unit-tests-1.md
  • writing-unit-tests-2.md
  • writing-unit-tests-3.md
  • writing-unit-tests-4.md
  • writing-unit-tests-5.md
  • writing-unit-tests-6.md
  • writing-unit-tests-7.md
  • adding-telemetry.md
  • error-handling-1.md
  • error-handling-2.md
• Updated headings so that there’s only one H1, each section (which were previously separate pages) now begins with an H2
• Updated Table of Contents section in the beginning to match the new headings and link down to each section
• Updated links so that all links point to absolute links since they are all pulled from separate repositories using the MkDocs - multirepo plugin
• Links are currently using the GitHub pages dev site, need to be updated to fprime.jpl.nasa.gov URLs once site goes live
• Any Notes or sections with > have been converted to have Material for MkDocs Admonition/Callout styling. They now start with “!!! note” and are rendered normally when on the website.

Rationale

The F Prime website has been converted from regular markdown hosted on GitHub pages to using MkDocs framework with the Material theme. The Material for MkDocs theme includes three types of navigation: navigation tabs in the top menu, a left sidebar for sub-page navigation, and a right sidebar for page section navigation. The right sidebar now takes the place of the original left navigation menu on the old website. Now that there is a more robust navigation system, all the tutorial materials can be combined into one page so that relevant information stays grouped together.

Testing/Review Recommendations

Please focus on the flow of the combined sections and for any broken links. No other content was changed.

Future Work

• Update links to go to the fprime.jpl.nasa.gov domain
• Remove _include>toc.md since there is already a built in navigation with MkDocs

[thomas-bc]

NO MERGE

Let's wait until we're closer to releasing the website before we merge this.