Guidance on how to (re?)integrate Plotly.NET into the build pipeline

plotly / documentation

Issue tracker for Plotly's open-source documentation.

421 stars 551 forks source link

Guidance on how to (re?)integrate Plotly.NET into the build pipeline #1696

Open kMutagene opened 1 year ago

kMutagene commented 1 year ago

Hi there @nicolaskruchten , recent issues (https://github.com/plotly/Plotly.NET/issues/353, https://github.com/plotly/Plotly.NET/issues/356) in Plotly.NET brought up a confusion regarding the official docs, which are severely out of date. To fix that, i'd like to ask for some guidance on the following things:

how does the current docs build pipeline work for Plotly.NET F# and C# samples? Is the content of https://github.com/plotly/plotly.net-docs used for that?
Is there a way to build those docs locally? https://github.com/plotly/plotly.net-docs has no readme.
Can we move the docs over to the Plotly.NET repos, the same way it is handled for python, js, and R repositories? That would make it way easier for me to maintain.

nicolaskruchten commented 1 year ago

So as far as I remember, the plotly.net-docs repo is hooked into things via CircleCI: https://github.com/plotly/plotly.net-docs/blob/main/.circleci/config.yml ... that causes the notebooks to be executed into HTML and pushed to the built branch of that repo, and then triggers a rebuild/redeploy of the contents of https://plotly.com/fsharp/ via the commit to the graphing-library-docs repo. So ATM to update things you "just" need to commit to the plotly.net-docs repo.

If you want to migrate this process to some other repo, you'd need to merge this CircleCI config or equivalent into your own repo and get the same sort of hooks set up.

I'm no longer working for Plotly full-time, so I can't really help with this process, but maybe @HammadTheOne @LiamConnors @alexcjohnson can help?

kMutagene commented 1 year ago

Thanks for the insights @nicolaskruchten

@alexcjohnson if i understand correctly, the only thing needed to get this started would be getting push rights to https://github.com/plotly/plotly.net-docs, would that be possible?

kMutagene commented 3 weeks ago

Hey @alexcjohnson @gvwilson There was a 'maintained by the plotly community' badge added to https://github.com/plotly/plotly.net-docs , but without answers/solutions to the questions above, i just cannot do that (also, i do not have maintenance access to that repo either).

There is also an open PR https://github.com/plotly/plotly.net-docs/pull/21 by @LiamConnors so it seems like you guys still want up-to date F#/C# docs. However, given the current state those docs are horribly outdated and do more damage than good (they are on a preview version of 2.0.0, while latest is 5.0.0 with many backwards-incompatible changes).

We still host our own, up-to date documentation and i would be up for porting those into your system provided we can get the general setup sorted out.