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

Learning paths #425

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
Draft

Learning paths #425

wants to merge 12 commits into from

Conversation

jhkrug
Copy link
Contributor

@jhkrug jhkrug commented Jul 15, 2024 •
edited
Loading

First draft. To take a look at learning paths.

Two questions:

  • Is it worth having?
  • Does it look ok if it is?

@jhkrug
First draft
b03d768 
Signed-off-by: John Krug <john.krug@suse.com>
@jhkrug jhkrug added the area/documentation Improvements or additions to documentation label Jul 15, 2024
@jhkrug jhkrug self-assigned this Jul 15, 2024
@netlify Netlify
Copy link

netlify bot commented Jul 15, 2024 •
edited
Loading

✅ Deploy Preview for silly-bunny-8cedd0 ready!

Name Link
🔨 Latest commit f38e75d
🔍 Latest deploy log https://app.netlify.com/sites/silly-bunny-8cedd0/deploys/66a2274a92fe8a00078a35e7
😎 Deploy Preview https://deploy-preview-425--silly-bunny-8cedd0.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.

@jhkrug jhkrug changed the title First draft Learning paths Jul 15, 2024
@jhkrug
missing files for the DS build
87d621c 
Signed-off-by: John Krug <john.krug@suse.com>
viccuad
viccuad reviewed Jul 16, 2024
View reviewed changes
Copy link
Member

@viccuad viccuad left a comment

Choose a reason for hiding this comment

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

I think it's a good addition, but maybe is enough with a page as I don't expect each persona to have a lot of content. The table/index is a good idea even if everything is in one page.

@jhkrug
Added in the learning path content for each persona.
39a75b9 
Signed-off-by: John Krug <john.krug@suse.com>
@jhkrug
fix paths
621322b 
Signed-off-by: John Krug <john.krug@suse.com>
@jhkrug
Improving content and table layout
a63fe69 
Signed-off-by: John Krug <john.krug@suse.com>
@jhkrug
add the doc-type
e4d216c 
Signed-off-by: John Krug <john.krug@suse.com>
@jhkrug
Playing around with formatting.
d441366 
Signed-off-by: John Krug <john.krug@suse.com>
@jhkrug
Copy link
Contributor Author

jhkrug commented Jul 18, 2024 •
edited
Loading

Moving to review, still in draft. Any further feedback?

Relevant pages at https://deploy-preview-425--silly-bunny-8cedd0.netlify.app/next/learnpaths/paths

@jhkrug jhkrug linked an issue Jul 18, 2024 that may be closed by this pull request
Provide guided paths to documentation for differing personas. #400
Open
jvanz
jvanz requested changes Jul 18, 2024
View reviewed changes
Copy link
Member

@jvanz jvanz left a comment

Choose a reason for hiding this comment

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

Overall, LGMT. But I don't think is necessary to have the location in the tables. The type should be enough. As the table has the links, I do not see the purpose to have the link path in the table. I'll never copy it if I have the link in the same row.

@jhkrug
Copy link
Contributor Author

jhkrug commented Jul 18, 2024

Overall, LGMT. But I don't think is necessary to have the location in the tables. The type should be enough. As the table has the links, I do not see the purpose to have the link path in the table. I'll never copy it if I have the link in the same row.

Yeah, still messing around with the available data and how to present it best. I think I need to work on a more tree like presentation.

jvanz
jvanz reviewed Jul 19, 2024
View reviewed changes
Copy link
Member

@jvanz jvanz left a comment

Choose a reason for hiding this comment

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

LGTM

viccuad
viccuad reviewed Jul 19, 2024
View reviewed changes
docs/learnpaths/paths.md Outdated Show resolved Hide resolved
viccuad
viccuad reviewed Jul 19, 2024
View reviewed changes
docs/learnpaths/paths.md Outdated Show resolved Hide resolved
viccuad
viccuad reviewed Jul 19, 2024
View reviewed changes
Copy link
Member

@viccuad viccuad left a comment

Choose a reason for hiding this comment

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

Looks nice, but I have some comments.

If possible for the autogenerated pages, I would prefer to list links in the same order as they are on the left section (first tutorials, then explanations, how-tos, and last reference).

@jhkrug
Copy link
Contributor Author

jhkrug commented Jul 22, 2024

Looks nice, but I have some comments.

If possible for the autogenerated pages, I would prefer to list links in the same order as they are on the left section (first tutorials, then explanations, how-tos, and last reference).

Yes, working on that sort of thing.

@jhkrug
Incorporating suggestion from the team.
a2390dd 
Signed-off-by: John Krug <john.krug@suse.com>
@jhkrug
Improved titles and descriptions.
96f8e5b 
Signed-off-by: John Krug <john.krug@suse.com>
@jhkrug
Improved ordering, not yet complete though.
9725aee 
Signed-off-by: John Krug <john.krug@suse.com>
@jhkrug
further ordering
fb32573 
Signed-off-by: John Krug <john.krug@suse.com>
@jhkrug
Merge remote-tracking branch 'upstream/main' into persona-paths
f38e75d 
New frontmatter.
@viccuad viccuad added this to the 1.16 milestone Jul 26, 2024
@jhkrug jhkrug removed this from the 1.16 milestone Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@viccuad viccuad viccuad left review comments

@jvanz jvanz jvanz requested changes

Assignees

@jhkrug jhkrug

Labels
area/documentation Improvements or additions to documentation
Projects
Kubewarden
Status: No status
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Provide guided paths to documentation for differing personas.
3 participants
@jhkrug @jvanz @viccuad