-
-
Notifications
You must be signed in to change notification settings - Fork 484
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
Improve home page #6422
Improve home page #6422
Conversation
|
||
```{notebook} panel ../examples/homepage.ipynb | ||
:disable_interactivity_warning: True | ||
``` | ||
|
||
<br/> | ||
|
||
Panel makes it simple to: | ||
|
||
- Develop in your favorite **editor or notebook** environment | ||
- Combine the **PyData tools and plotting libraries** that you know and love |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Seamlessly publish your app to the web from a Notebook environment.
|
||
```{notebook} panel ../examples/homepage.ipynb | ||
:disable_interactivity_warning: True | ||
``` | ||
|
||
<br/> | ||
|
||
Panel makes it simple to: | ||
|
||
- Develop in your favorite **editor or notebook** environment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Develop in your favorite editor or notebook environment and seamlessly publish the result to the web.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay maybe add this part "seamlessly publish the result to the web." when there is clear documentation on how to do that :-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm in doubt:
- Should "seamlessly publish the result to the web" be included?
- If yes. Should it be a separate bullet point?
Could you elaborate on why this is important to add to an already long list of items?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the ability to do that is important, and even fundamental for many use cases.
Publishing a development project as a webpage directly from your environment or Notebook without cumbersome deployment / conversion etc. etc. is (in my opinion) an important box to check for many users.
Together with the ability to then quickly iterate your development and immediately see the results in the webpage.
So there is a Notebook or other environment level where you can develop with other developers, and at the same time you have a (selective, constrained, polished) app that you serve from that environment to users.
So it enables an almost instant develop <-> web loop. Do others not also emphasize this? Like Gradio, etc.? Or the framework that mainly uses Plotly (is that Streamlit or another one?). I think it is an important part in many development cycles.
I think that part is pretty essential as a selling point, but would be good, but I don't know the user base well enough. Maybe others can chime in that have a good feel for the (potential) user base? @jbednar, any thoughts?
Conversely: are there also many cases where people do NOT need this in their project? So they stay entirely in a local environment / Notebook, and never need to pubish to a webpage?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it align with the roadmap? doc/about/roadmap.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@MarcSkovMadsen See suggested changes in comments. Looks good.
@@ -130,19 +136,19 @@ The Component Gallery showcases Panel's components and their essential reference | |||
:link: how_to/index | |||
:link-type: doc | |||
|
|||
How-to guides provide step by step recipes for solving essential problems and tasks that arise during your work. | |||
How-to guides provide step-by-step recipes for solving essential problems and tasks that arise during your work. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How-to guides provide step-by-step recipes for solving essential problems and tasks you encounter on a daily basis.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would argue that a lot of the recipes are for solving tasks that arise for many people (not all) sometimes during their work.
For example advanced deployment or finetuning of the server is not something every one does and not daily.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see your point. So maybe something like ... that arise when analyzing, visualizing and publishing data in a broad range of scenario's? Basically stating the main challenges Panel can help solve?
@@ -6,7 +6,7 @@ Now, let's explain the core concepts of Panel. | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lower down in the page it says this:
- If you're unsure, starting in a notebook is recommended as you familiarize yourself with Panel. However, you can switch between them at any time.
Suggested additional sentence: Hosted Notebook environements like https://ananconda.cloud and others are available for a quick start (or something similar).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe. Can you explain why this is important?
If this should be included. It could be included in different places: Installation, core_concepts
, its own guide(s) similar to the Deployment guides. What would be the best place to include this?
There was a problem hiding this 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 important (or at least relevant) because people might not be aware that this is an alternative to setting up and installing Jupyter from the ground up. That step can add al ot of friction for certain users in my view.
Hosted Notebooks allow them to skip that initially, and get to a working Panel example quickly, with as little friction as possible.
They can then always to choose to use the created .ipynb Notebook files in other (local) environments later.
Heh just found the roadmap at doc/about/roadmap.md |
Breaks up the first text heavy section and