-
-
Notifications
You must be signed in to change notification settings - Fork 527
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
Conversation
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 . |
Codecov ReportAll modified and coverable lines are covered by tests ✅
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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
…es_1.4_a1_review
…/panel into docs_fixes_1.4_a1_review
…es_1.4_a1_review
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. |
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 |
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. |
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? |
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 |
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. |
Addresses #6215
You can preview here https://holoviz-dev.github.io/panel/tutorials/index.html
Todo by Philipp
{pyodide}
code blocks produce the expected output (currently no output is produced).Todo some day maybe
pn.state.served
and--index
. And add links fromserve.md
.