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

Docs: Updates of the Tutorial documentation #1089

Merged
merged 4 commits into from
Dec 1, 2021
Merged

Docs: Updates of the Tutorial documentation #1089

merged 4 commits into from
Dec 1, 2021

Conversation

JohanBertrand
Copy link
Contributor

Originating Project/Creator @Blabla51
Affected Component Docs
Affected Architectures(s)
Related Issue(s)
Has Unit Tests (y/n)
Builds Without Errors (y/n)
Unit Tests Pass (y/n)
Documentation Included (y/n)

Change Description

The markdown used for the numbered lists in the tutorials was not following the kramdown syntax, making the tutorial harder to read.
The top image of the MathComponent tutorial has been updated
The path to the MathComponent tutorial code has been added.
If the tutorial is done in a Docker container on Windows, there are some step to follow in order to access to the fprime-gds GUI in the web browser, since no GUI are available in a basic Docker container

Rationale

  • Tutorials readability improved
  • New instructions to run the MathComponent tutorial in a Docker container on Windows

Testing/Review Recommendations

  • Review the section 4.2 of the MathComponent tutorial

Future Work

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.

Looks good to me. We are reworking this for v3.0.0 so I'll have @bocchino review as well.

@LeStarch
Copy link
Collaborator

LeStarch commented Dec 1, 2021

Will merge this in for v2. In v3, we have a revamped tutorial.

@LeStarch LeStarch merged commit 9b52ddd into nasa:devel Dec 1, 2021
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.

2 participants