Skip to content

feat(doc): update quick start and UI docs #2622

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
Merged
merged 15 commits into from
May 25, 2025
Merged

feat(doc): update quick start and UI docs #2622

merged 15 commits into from
May 25, 2025

Conversation

adarsh0728
Copy link
Contributor

@adarsh0728 adarsh0728 commented May 9, 2025 •
edited
Loading

fixes #2621

  • Updated quick-start doc
  • Added latest UI screenshots
  • Simple MonoVertex set up guide in quick-start
  • Added UI docs
    • Logs
    • Pods View
    • Metrics
    • Errors
    • Overview
  • Updated mkdocs [UI, FAQs and SQS Source]
  • Fixed some broken links including Users.md https://bcubed.com
  • Updated lychee [include all links in all docs subdirectories except specific exclusions]
  • Verified changes using sites/ folder

adarsh0728 added 2 commits May 9, 2025 20:11
@adarsh0728
enhance quick start doc
f0abd5b 
Signed-off-by: adarsh0728 <gooneriitk@gmail.com>
@adarsh0728
start UI documentation
e1baa1d 
Signed-off-by: adarsh0728 <gooneriitk@gmail.com>
@codecov Codecov
Copy link

codecov bot commented May 9, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.00%. Comparing base (d419358) to head (dd3494e).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #2622      +/-   ##
==========================================
+ Coverage   72.99%   73.00%   +0.01%     
==========================================
  Files         407      407              
  Lines       70219    70219              
==========================================
+ Hits        51255    51266      +11     
+ Misses      17845    17836       -9     
+ Partials     1119     1117       -2

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

adarsh0728 added 3 commits May 9, 2025 20:53
@adarsh0728
minor fixes
6bc9eca 
Signed-off-by: adarsh0728 <gooneriitk@gmail.com>
@adarsh0728
added logs doc
c35ae4a 
Signed-off-by: adarsh0728 <gooneriitk@gmail.com>
@adarsh0728
added errors doc
c5c125a 
Signed-off-by: adarsh0728 <gooneriitk@gmail.com>
vigith
vigith reviewed May 13, 2025
View reviewed changes
docs/user-guide/UI/logs.md Outdated

<video controls>

<source src="../../assets/logs/ui-logs-video.mp4" type="video/mp4">
Copy link
Member

Choose a reason for hiding this comment

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

please upload to youtube. @syayi can help you. Eg., https://github.com/numaproj/numaflow/blob/main/README.md?plain=1#L43

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. Size would be an issue. Will upload on youtube. Will connect with @syayi

adarsh0728 added 3 commits May 13, 2025 21:05
@adarsh0728
refactor code and added pods-view doc
9d27bb6 
Signed-off-by: adarsh0728 <gooneriitk@gmail.com>
@adarsh0728
minor fixes
88beca4 
Signed-off-by: adarsh0728 <gooneriitk@gmail.com>
@adarsh0728
metrics tab
95d0af7 
Signed-off-by: adarsh0728 <gooneriitk@gmail.com>
@adarsh0728 adarsh0728 self-assigned this May 15, 2025
@adarsh0728
Copy link
Contributor Author

@syayi : could you please review the content? I am thinking of reducing file size of the screenshots that i have added.

@adarsh0728 adarsh0728 requested a review from syayi May 16, 2025 05:23
@adarsh0728 adarsh0728 closed this May 19, 2025
@adarsh0728 adarsh0728 deleted the docs/updation branch May 19, 2025 23:29
@adarsh0728 adarsh0728 restored the docs/updation branch May 19, 2025 23:29
@vigith vigith reopened this May 20, 2025
@adarsh0728
Copy link
Contributor Author

adarsh0728 commented May 20, 2025 •
edited
Loading

I accidentally deleted the branch, that's why the PR got closed. Thanks @vigith for re-opening it.

syayi
syayi reviewed May 20, 2025
View reviewed changes
docs/quick-start.md Outdated
This renders the following UI on https://localhost:8443/.
Visit https://localhost:8443/ to view the UI. Below is the UI for the `simple` pipeline:

#### Namespaces View
Copy link
Member

Choose a reason for hiding this comment

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

Cluster View

adarsh0728 added 5 commits May 23, 2025 09:03
@adarsh0728
Merge branch 'main' into docs/updation
9c969cb
@adarsh0728
added UI overview
3de0a46 
Signed-off-by: adarsh0728 <gooneriitk@gmail.com>
@adarsh0728
refactor
acbf726 
Signed-off-by: adarsh0728 <gooneriitk@gmail.com>
@adarsh0728
fix broken links and update lychee
61dd139 
Signed-off-by: adarsh0728 <gooneriitk@gmail.com>
@adarsh0728
Merge branch 'main' into docs/updation
dff23e2
@adarsh0728 adarsh0728 marked this pull request as ready for review May 24, 2025 11:03
@adarsh0728 adarsh0728 requested a review from whynowy as a code owner May 24, 2025 11:03
vigith
vigith requested changes May 24, 2025
View reviewed changes
mkdocs.yml Outdated
Copy link
Member

Choose a reason for hiding this comment

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

This is a new layout. @whynowy are you okay with this?

please revert the unexpected formatting changes in this file.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will revert the formatted changes.
Apart from that, following is the diff

  • added UI section under User Guide
  • FAQs section under User Guide

Copy link
Member

Choose a reason for hiding this comment

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

There are formatting changes in other files too, please fix those too.

adarsh0728 added 2 commits May 25, 2025 17:10
@adarsh0728
refactor
667a6b8 
Signed-off-by: adarsh0728 <gooneriitk@gmail.com>
@adarsh0728
Merge branch 'main' into docs/updation
dd3494e
vigith
vigith approved these changes May 25, 2025
View reviewed changes
Copy link
Member

@vigith vigith left a comment

Choose a reason for hiding this comment

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

thank you :)

@vigith vigith changed the title chore: update quick start and UI docs feat(doc): update quick start and UI docs May 25, 2025
@vigith vigith merged commit d264f0e into numaproj:main May 25, 2025
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@syayi syayi syayi left review comments

@vigith vigith vigith approved these changes

@whynowy whynowy Awaiting requested review from whynowy whynowy is a code owner

Assignees

@adarsh0728 adarsh0728

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update the Quick Start docs with the new UI screenshots
3 participants
@adarsh0728 @vigith @syayi