Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[python docs] Plotly Fundamentals reorg #1360

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
Closed
nicolaskruchten opened this issue Jun 13, 2019 · 7 comments · Fixed by #1368
Closed

[python docs] Plotly Fundamentals reorg #1360

nicolaskruchten opened this issue Jun 13, 2019 · 7 comments · Fixed by #1368

Comments

@nicolaskruchten
Copy link
Contributor

Given that the plan for the v4 docs is to use the current framework for final deployment, it makes sense to start the structural reorg in this repo now!

There are two related things I'd like to tackle first:

  1. There are a bunch of pages in "Plotly Fundamentals" that are actually "Chart Studio Fundamentals" and should be de-emphasized/removed from the top of the docs
  2. There are a bunch of pages lower down on the main page that are actually "Plotly Fundamentals" that should be moved up into a more prominent position like Legends, Axes, Subplots and various other styling-related pages

@michaelbabyn and I have been chatting about this and I'd love to workshop a list of the changes we could make here... If you could share what you've thought about so far Michael that would be helpful :)
@nicolaskruchten
Copy link
Contributor Author

Here's a good candidate for the "chart studio" section :)

image

@michaelbabyn
Copy link
Contributor

I also think the current docs in Add custom controls (Custom buttons, Sliders and Dropdown menus from) can go to the chart studio section as well since ipywidgets and FigureWidgets is the better/easier option offline. And everything currently in fundamentals aside from the 2 orca docs, the config doc and the jupyter notebook doc (although this one does have a few chart studio related sections) could be moved to chart studio.

@michaelbabyn
Copy link
Contributor

When I was looking at other docs that would work best in fundamentals (from the current layout and style sections) this is the list i cam up with:

Axes, subplots, multiple axes, graph sizing, setting the titles, legends, text and annotations, text and font styling, hover text, Images, shapes, colorway, and one of the three colorscales docs.

I also figured that since the above would break apart the layout section we could consolidate the 3D specific docs that are currently in the layout section into the 3D section.

@nicolaskruchten
Copy link
Contributor Author

I'm good with making this change now. @cldougl thoughts?

@nicolaskruchten
Copy link
Contributor Author

Related: any files impacted by the changes in https://github.com/plotly/plotly.py-docs/issues/16 should go into the "chart studio" bucket :)

@cldougl
Copy link
Member

cldougl commented Jun 17, 2019

I'm good with this change!

@nicolaskruchten
Copy link
Contributor Author

Great! @michaelbabyn this spreadsheet has certain pages tagged "chart studio" or "framework" that might be good candidates for getting shunted into Chart Studio or Fundamentals or an eventual "Advanced" category for the non-fundamental-yet-still-framework ones :)

@michaelbabyn michaelbabyn mentioned this issue Jun 21, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Chart studio python reorg plotly/documentation
3 participants
@nicolaskruchten @cldougl @michaelbabyn