knative / docs

User documentation for Knative components.
https://knative.dev/docs/
Other
4.41k stars 1.22k forks source link

Sample App Tutorial Page Compilation #6007

Closed Leo6Leo closed 1 week ago

Leo6Leo commented 4 weeks ago

fixes #5938

Proposed Changes

netlify[bot] commented 4 weeks ago

Deploy Preview for knative ready!

Built without sensitive environment variables

Name Link
Latest commit 10b0ae6338621edb02859f77ccf41cc939e81139
Latest deploy log https://app.netlify.com/sites/knative/deploys/66748d7a707cdc0008522b90
Deploy Preview https://deploy-preview-6007--knative.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

pierDipi commented 4 weeks ago

Thanks Leo, this is great!

aliok commented 4 weeks ago

I think we should play with the link titles here.

"Bookstore tutorial" and "Quickstart", wdyt?

Screenshot 2024-06-05 at 16 42 51

Leo6Leo commented 4 weeks ago

I think we should play with the link titles here.

"Bookstore tutorial" and "Quickstart", wdyt?

Screenshot 2024-06-05 at 16 42 51

I can create a tread and ask how UX WG think, and whether designers have some ideas on it! The thread for this discussion is here.

Cali0707 commented 4 weeks ago

@Leo6Leo instead of adding another tab to the top level navigation (which is already too full according to the UX group), can we put the bookstore tutorial under the already existing Tutorial tab? Maybe we can have a start page there that opens to either the quickstart tutorial or the e2e bookstore tutorial?

Leo6Leo commented 4 weeks ago

@Leo6Leo instead of adding another tab to the top level navigation (which is already too full according to the UX group), can we put the bookstore tutorial under the already existing Tutorial tab? Maybe we can have a start page there that opens to either the quickstart tutorial or the e2e bookstore tutorial?

Yeah I do agree, the current top level navigation is really packed. And a start page idea sounds good to me! I will reflect the changes in this PR.

DhairyaMajmudar commented 4 weeks ago

How's about adding it in sidebar of getting-started-page ?

And adding a button in home page which can will take users directly to tutorial page, just like it is there in NextJs home page

Header Header
image image
asr2003 commented 3 weeks ago

Yes, I agree with @Cali0707. Current nav bar already been tightly packed :) Hopefully we have new design getting it narrow down. Yes, it's good to have in quick start tutorial that current explore knative button in the home page redirects there

asr2003 commented 3 weeks ago

Something from the user perspective, a user(this can be me) can be curious to see what's newly added to the Knative. For an instance, we have introduced this Bookstore tutorial or new releases or new events etc.. It can make a quick access and overview of the what's the latest news of Knative. Can we add any section of What's new? If yes, we can add this beside Needs to Know more, something it seems like we are using more space here :)

cc: @knative/ux-wg-leads

image

Cali0707 commented 3 weeks ago

Hey @asr2003 that's a neat idea, but I don't think this is the best spot to discuss that. Normally on PRs we just discuss the changes involved in this PR, not ideas for other changes. I would recommend opening an issue in the UX repository or starting a new thread on slack

asr2003 commented 3 weeks ago

Just got this idea while exploring this PR, so i have dropped my idea here without further missing any from my mind :)

Okay, we can continue this in our existing thread in ux channel

Leo6Leo commented 3 weeks ago

/hold Will unhold on June 11 when it is ready to be merged

sandipkumardey commented 3 weeks ago

I have found some necessary UI improvements on the Doc Feature and listed all in a new issue req-https://github.com/knative/docs/issues/6012

pierDipi commented 3 weeks ago

image

image

I think the URLs are a little cryptic, can we call pages the same as the title of the page with dash for spaces ?

pierDipi commented 3 weeks ago

the mode button is huge compared to other components

image

Leo6Leo commented 3 weeks ago

the mode button is huge compared to other components

image

Should we make it smaller? This is the design from one of the designers in the UX WG.

pierDipi commented 1 week ago

@matzew is this PR something you can take a look at?

matzew commented 1 week ago

A nice, and lengthly tutorial

This is something that we could use for like 3 hiur workshops at conferences.

Very nice !

matzew commented 1 week ago

LGTM

I am not sure if some of @pierDipi's comments need to be addressed as well - mine are cosmetics, and I added hints what I found sub-optimal, feel free to polish this in a different PR

pierDipi commented 1 week ago

/lgtm /approve

knative-prow[bot] commented 1 week ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Leo6Leo, pierDipi

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: - ~~[OWNERS](https://github.com/knative/docs/blob/main/OWNERS)~~ [Leo6Leo] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
matzew commented 1 week ago

/unhold

matzew commented 1 week ago

/cherry-pick release-1.14

knative-prow-robot commented 1 week ago

@matzew: #6007 failed to apply on top of branch "release-1.14":

Applying: feat: add the first three pages of the sample app tutorial
Applying: Apply suggestions from code review
Applying: fix: fix the review comments in pg0 and pg1
Applying: feat: add blog post 2
Applying: feat: adding the images for page 2
Applying: add: add more pages
Applying: add: adding the rest of the pages
Applying: add: modify the nav
Applying: add: finishing polishing
Applying: fix: update the iframe embedded video link
Applying: fix: fix the video embedding dimension and the access
Applying: fix: link minor error fix
Applying: fix: hide the setup script section
Applying: Apply suggestions from code review
Applying: Update docs/bookstore/page-0/page-0-intro.md
Applying: Update docs/bookstore/page-0.5/pg0.5-env-setup.md
Applying: fix: fix christoph's comment
Applying: fix: Remove all the extra new lines
Applying: fix: update kubernetes to Kubernetes
Applying: Apply suggestions from code review
Applying: fix: fix the wrong indentation in the yaml files
.git/rebase-apply/patch:107: trailing whitespace.

.git/rebase-apply/patch:139: trailing whitespace.
    ```yaml 
.git/rebase-apply/patch:183: trailing whitespace.
      badwordfilter: 
.git/rebase-apply/patch:205: trailing whitespace.
    ```yaml 
.git/rebase-apply/patch:279: trailing whitespace.
    ```yaml 
warning: 5 lines add whitespace errors.
Using index info to reconstruct a base tree...
A   code-samples/eventing/bookstore-sample-app/solution/node-server/config/100-event-display.yaml
A   code-samples/eventing/bookstore-sample-app/start/slack-sink/application.properties
Falling back to patching base and 3-way merge...
CONFLICT (modify/delete): code-samples/eventing/bookstore-sample-app/start/slack-sink/application.properties deleted in HEAD and modified in fix: fix the wrong indentation in the yaml files. Version fix: fix the wrong indentation in the yaml files of code-samples/eventing/bookstore-sample-app/start/slack-sink/application.properties left in tree.
CONFLICT (modify/delete): code-samples/eventing/bookstore-sample-app/solution/node-server/config/100-event-display.yaml deleted in HEAD and modified in fix: fix the wrong indentation in the yaml files. Version fix: fix the wrong indentation in the yaml files of code-samples/eventing/bookstore-sample-app/solution/node-server/config/100-event-display.yaml left in tree.
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0021 fix: fix the wrong indentation in the yaml files
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
In response to [this](https://github.com/knative/docs/pull/6007#issuecomment-2191162552): >/cherry-pick release-1.14 Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
matzew commented 1 week ago

ok, than not :-)