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

Revamp docs & codebase #542

Merged
merged 6 commits into from
Nov 8, 2024
Merged

Conversation

lucferbux
Copy link
Contributor

Description

Revamp docs to speed up onboarding and a add some automated scripts

How Has This Been Tested?

Merge criteria:

  • All the commits have been signed-off (To pass the DCO check)
  • The commits have meaningful messages; the author will squash them after approval or in case of manual merges will ask to merge with squash.
  • Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
  • The developer has manually tested the changes and verified that the changes work.
  • Code changes follow the kubeflow contribution guidelines.

If you have UI changes

  • The developer has added tests or explained why testing cannot be added.
  • Included any necessary screenshots or gifs if it was a UI change.
  • Verify that UI/UX changes conform the UX guidelines for Kubeflow.

@lucferbux lucferbux force-pushed the rhoaieng-13852 branch 2 times, most recently from 256d856 to 974c228 Compare November 8, 2024 11:07
@google-oss-prow google-oss-prow bot added size/XL and removed size/L labels Nov 8, 2024
@lucferbux lucferbux force-pushed the rhoaieng-13852 branch 4 times, most recently from f5e4bc2 to 96c6382 Compare November 8, 2024 12:39
Signed-off-by: lucferbux <[email protected]>
Signed-off-by: lucferbux <[email protected]>
Signed-off-by: lucferbux <[email protected]>
@lucferbux lucferbux changed the title Revamp docs Revamp docs & codebase Nov 8, 2024
lucferbux and others added 2 commits November 8, 2024 16:53
Co-authored-by: Alex Creasy <[email protected]>
Signed-off-by: Lucas Fernandez <[email protected]>
Signed-off-by: lucferbux <[email protected]>
Copy link
Member

@ederign ederign left a comment

Choose a reason for hiding this comment

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

Lucas great work! Worked like magic:

Screenshot 2024-11-08 at 2 22 31 PM

Suggested future improvements

  • on make dev-bff: be able to configure the port and mock options
  • small typo on deploykindcluster.sh L 53
  • create a way to delete deployment of a cluster and rebuild and redeploy.

But all of those can be done in FUP PR's. I'll merge this because I'll make a FUP PR on top of it!.

@ederign
Copy link
Member

ederign commented Nov 8, 2024

/lgtm

Copy link
Contributor

@rareddy rareddy left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ederign, rareddy

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants