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 beginner tutorial: Change front end, suggestions for localhost running, reformat tutorial #733

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

Justin-Zwart
Copy link
Collaborator

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.

Copy link

codecov bot commented Aug 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@pboers1988
Copy link
Member

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

Copy link
Member

@pboers1988 pboers1988 left a comment

Choose a reason for hiding this comment

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

Pre-commit (linting) is failing

@Justin-Zwart
Copy link
Collaborator Author

@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.

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