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.

Sign up for GitHub

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

Jump to bottom

fix(docs): updates docs and steps for local dev-env #787

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

fix(docs): updates docs and steps for local dev-env #787

wants to merge 2 commits into from
+60 −77

Conversation

olandr
Copy link
Contributor

@olandr olandr commented Nov 27, 2024 •
edited
Loading

The PR #567 removed the ui directory and migrated the Greenhouse UI to https://github.com/cloudoperators/juno.

This PR updates various broken references, links and configurations to accommodate for this migration. It also adds steps for building the juno-app-greenhouse locally.

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help
  • Separate ticket for tests # (issue/pr)

Added to documentation?

  • 📜 README.md
  • 🤝 Documentation pages updated
  • 🙅 no documentation needed
  • (if applicable) generated OpenAPI docs for CRD changes

Documentation will be handled in a separate PR.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 27, 2024
@olandr olandr changed the title fix/update dev env setup fix(dev-env): updates docs and steps for local dev-envtest Nov 27, 2024
@olandr olandr changed the title fix(dev-env): updates docs and steps for local dev-envtest fix(dev-env): updates docs and steps for local dev-env Nov 27, 2024
@olandr olandr changed the title fix(dev-env): updates docs and steps for local dev-env fix(docs): updates docs and steps for local dev-env Nov 27, 2024
@olandr olandr marked this pull request as ready for review November 27, 2024 15:24
@olandr olandr requested review from a team as code owners November 27, 2024 15:24
@olandr
Copy link
Contributor Author

olandr commented Nov 27, 2024

This would possibly render the branch ui-before-migration redundant.

@olandr
Copy link
Contributor Author

olandr commented Nov 28, 2024

@abhijith-darshan How does this PR play with yours #775? This PR is changing docs and making the local dev a bit easier to do, but your PR is a completely changing it.

You do not touch the juno/ui thing right? So maybe we pivot this PR to be focusing on how to play ball with that change?

@abhijith-darshan
Copy link
Contributor

@abhijith-darshan How does this PR play with yours #775? This PR is changing docs and making the local dev a bit easier to do, but your PR is a completely changing it.

You do not touch the juno/ui thing right? So maybe we pivot this PR to be focusing on how to play ball with that change?

@olandr - both solutions exist side by side for now until the new KinD based setup reaches parity with the docker-compose setup. So I would say go ahead and continue with your PR.

IvoGoman
IvoGoman approved these changes Dec 10, 2024
View reviewed changes
Copy link
Contributor

@IvoGoman IvoGoman left a comment

Choose a reason for hiding this comment

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

Thanks for the improvements @olandr 🥇

@olandr
fix(dev-env): resolves local dev-env breaking changes from #567
ffba9d8 
Due to #567 removal of the ui dir plenty of local environment changes had to be updated.
- Updates compose files to reference juno image
- Updates appProps to use the mockAuth value
- Removes broken Dockerfile
- Updates helm-chart and adds kubeconfig export of remote-cluster for onboarding cluster script

---------

Signed off by: Simon Olander ([email protected])
@olandr
chore(docs): update docs for dev-env local installation
fae95e6 
- Fixes broken links
- Rewrites UI-segments in favour of a juno installation
- Adds a step-by-step installation process

---------

Signed off by: Simon Olander ([email protected])
@olandr olandr force-pushed the fix/update-dev-env-setup branch from 84cc451 to fae95e6 Compare December 11, 2024 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@IvoGoman IvoGoman IvoGoman approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@olandr @abhijith-darshan @IvoGoman