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

Add tutorial section for documentation #6213

Merged
merged 252 commits into from
Feb 25, 2024
Merged

Conversation

MarcSkovMadsen
Copy link
Collaborator

@MarcSkovMadsen MarcSkovMadsen commented Jan 16, 2024

Addresses #6215

You can preview here https://holoviz-dev.github.io/panel/tutorials/index.html

Todo by Philipp

  • Write the "React to User Input" section
  • Write the "Handle State" section
  • Combine the "Display Content with pn.panel" and "Display Content with Panes".
  • Align apps with updated material
    • Finalize "Build a todo app". I can explain it. But you need to update the code.
    • Finalize "Build an image classifier app". I can explain it. But you need to update the code.
  • Clear CDN cache for
  • Make sure all {pyodide} code blocks produce the expected output (currently no output is produced).
  • Make sure pyodide can run. Currently it cannot.
    image
  • Fix missing scroll. Example from layouts.md (regression?)
    image

Todo some day maybe

  • Add "download notebook button". Add "open in panelite" button.
  • Setup redirect for deleted guides.
  • Add missing how to guides on pn.state.served and --index. And add links from serve.md.

Base automatically changed from doc_fixes_1.4_a1 to main January 17, 2024 16:20
@MarcSkovMadsen
Copy link
Collaborator Author

If you have the time to review and align on tutorial you can review https://github.com/holoviz/panel/blob/docs_fixes_1.4_a1_review/doc/tutorials/serve.md @philippjfr .

Copy link

codecov bot commented Jan 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.61%. Comparing base (a88bd43) to head (a2d5437).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6213      +/-   ##
==========================================
+ Coverage   71.59%   71.61%   +0.01%     
==========================================
  Files         305      305              
  Lines       45594    45594              
==========================================
+ Hits        32643    32651       +8     
+ Misses      12951    12943       -8     
Flag Coverage Δ
unitexamples-tests 71.61% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@philippjfr philippjfr marked this pull request as ready for review February 25, 2024 16:59
@philippjfr philippjfr changed the title Docs fixes 1.4 a1 review Add tutorial section for documentation Feb 25, 2024
@philippjfr
Copy link
Member

At this point we have iterated a whole bunch here and I think the material is in a good state. There's still some work to be done but this PR is pretty unwieldy so I plan to open new PRs to address each of the missing tasks.

@philippjfr philippjfr merged commit 6ee12f6 into main Feb 25, 2024
13 of 16 checks passed
@philippjfr philippjfr deleted the docs_fixes_1.4_a1_review branch February 25, 2024 17:10
@Coderambling
Copy link
Contributor

Hi @MarcSkovMadsen and @philippjfr . I have some feedback on the text of Indicators. But where in Github do I go to fork it and edit the forked file with my suggestions? Or is that not the workflow in this case? Better to wait for this version to be released first, and then fork that version?

@MarcSkovMadsen
Copy link
Collaborator Author

Hi @MarcSkovMadsen and @philippjfr . I have some feedback on the text of Indicators. But where in Github do I go to fork it and edit the forked file with my suggestions? Or is that not the workflow in this case? Better to wait for this version to be released first, and then fork that version?

That sounds great. You can either describe your change requests in a new issue. Or even better make a PR from the main branch with your suggestions.

@Coderambling
Copy link
Contributor

Coderambling commented Feb 26, 2024

Hi @MarcSkovMadsen. Would prefer to do a PR, but what is the location of this file in main? I can go to this preview link: https://holoviz-dev.github.io/panel/tutorials/basic/indicators_performance.html, but I can't do a PR from there. The file is in Markdown I presume? Can you put a link to the file in a reply please? Thank you.

@Coderambling
Copy link
Contributor

Coderambling commented Feb 26, 2024

Hang on, found it I think... https://github.com/holoviz/panel/blob/docs_fixes_1.4_a1_review/doc/tutorials/basic/indicators_performance.md. Forked it, made edits and comments in the file. I have put a couple of comments / clarification inside the file though, so definitely can't be merged as is. Should I still do a PR?

@MarcSkovMadsen
Copy link
Collaborator Author

Yes. Please make a PR. But first remove the comments (Copy to your own notes).

When PR is made please comment using Github PR review functionality. You can add comments to the files. Or you can describe your comments directly there.

Looks good so far.

Thanks

@Coderambling
Copy link
Contributor

Coderambling commented Feb 27, 2024

Hi @MarcSkovMadsen . I can't find the version that contains my edits. Is it somewhere in the huge PR? I don't see it under Issues in my Github profile. Could you point me to where I can find it on Github?

Update: I stumbled upon it somehow. Made the edits again, and removed the comments. Let me know what you think. Messaged you on Discord by the way, but got some Message not received warning.

I think I was able to copy over the Markdown card item of the Windturbines example in the document, but could not find the Markdown file of the Indicator Component page. So I could copy the 2 x 5 Indicator Gallery to the top of the tutorial page. Could you point me to the Github link for the Component Gallery Markdown?

PS Is there a way to make a new version of my initial edited file? In this case I started again by editing your current file again, and submitted it as a PR. But would like to be able to iterate further on my edited file next time.

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.

7 participants