orchestrator-core icon indicating copy to clipboard operation
orchestrator-core copied to clipboard

Update beginner tutorial: Change front end, suggestions for localhost running, reformat tutorial

Open Justin-Zwart opened this issue 1 year ago • 1 comments

This PR was created to change a number of outdated features in the beginner tutorial, and add some clarity.

New features:

  • mention an easy way to run backend without auth in on localhost
  • update links to point to the correct location in the documentation
  • merge "overview" and "scenario" into one cohesive file explaining all the top-down approach
  • update debian.md and start_applications.md files to work with orchestrator-ui instead of orchestrator_core_gui

Continued work before this PR is ready to submit:

  • there is no explanation for how to set up the orchestrator-ui in macos, as I do not have the ability to set up / test
  • the dockerfile in the associated beginner orchestrator and the docker tutorial have not been updated to use the orchestrator-ui, as I have been running my setups manually.

Justin-Zwart avatar Aug 12 '24 21:08 Justin-Zwart

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 83.43%. Comparing base (70b0617) to head (bc273de).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #733   +/-   ##
=======================================
  Coverage   83.43%   83.43%           
=======================================
  Files         188      188           
  Lines        9287     9287           
  Branches     1523     1523           
=======================================
  Hits         7749     7749           
  Misses       1274     1274           
  Partials      264      264           
Flag Coverage Δ
83.43% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Aug 12 '24 21:08 codecov[bot]

@Justin-Zwart Thanks for the contribution. If you don't mind could you make sure it gets through pre-commit? Then we can accept.

pboers1988 avatar Sep 09 '24 13:09 pboers1988

@Justin-Zwart Thanks for the contribution. If you don't mind could you make sure it gets through pre-commit? Then we can accept.

Hi Peter,

I am happy to update the linting in the next couple of days. I have been super busy with the start of my school term. I also need someone other than myself to make progress on some of the code which I am not able to complete myself. I mention this in the description of the PR. For example I am not updating the docker and haven't tested it on Mac.

Justin-Zwart avatar Sep 18 '24 22:09 Justin-Zwart

Thanks LGTM

pboers1988 avatar Oct 07 '24 09:10 pboers1988