Skip to content

Repo shuffling proposal #1596

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

Closed
nicolaskruchten opened this issue Nov 14, 2019 · 8 comments
Closed

Repo shuffling proposal #1596

nicolaskruchten opened this issue Nov 14, 2019 · 8 comments
Assignees

Comments

@nicolaskruchten
Copy link
Contributor

nicolaskruchten commented Nov 14, 2019

I have a few concerns about this repository:

  1. the name is a bit too broad, in the presence of other doc repos like dash-docs and plotly.py-docs and plotly.github.io
  2. the main branch is source-design-merge instead of master
  3. it's really big due to its history

Here's something we could do:

  1. create a new repo graphing-library-docs and copy all of source-design-merge into master there
  2. have that repo CI still deploy to documentation/gh-pages (thereby requiring no nginx changes, and keeping the new repo slim)
  3. clear out the contents of the main branch here, replacing it with a single readme that says "we have many docs, here are links to them, feel free to file an issue here or in any of those other repos!"

thoughts @Mahdis-z @jdamiba @emmanuelle @cldougl @chriddyp ?

@nicolaskruchten
Copy link
Contributor Author

(note that this does not preclude the previously-discussed idea of moving the contents of plotly.py-docs into the plotly.py repo in the near term)

@Mahdis-z
Copy link
Contributor

Yeah, its giant, and this way it would be more straight forward for the contributors. Maybe api-docs?

@jdamiba
Copy link
Contributor

jdamiba commented Nov 15, 2019

I think that this should be quite safe if we modify the CircleCI config.yml to deploy to the gh-pages branch of the documentation repo.

My only question is if we will continue to append changes to the gh-pages branch in documentation? This seems like it would be a good opportunity to get rid of gremlins by having the gh-pages branch in documentation be the output of the build in the graphing-library-docs repo.

@emmanuelle
Copy link
Contributor

sounds good to me

@cldougl
Copy link
Member

cldougl commented Nov 15, 2019

no concerns come to mind from me

@nicolaskruchten
Copy link
Contributor Author

@jdamiba can you propose a plan here as a bulleted list of what we'd need to do to accomplish this? Or create a Google Doc and link to it here or whatever? :)

@jdamiba
Copy link
Contributor

jdamiba commented Jan 9, 2020

The workplan for this is as follows:

  • create plotly/graphing-libraries-docs repo
  • merge all open PRs in documentation:source-design-merge
  • clone contents of documentation:source-design-merge to graphing-libraries-docs:master
  • update graphing-libraries-docs:master/.circleci/config.yml to deploy to documentation:gh-pages after successfully building the site
  • clear out every master branch on plotly/documentation
  • update Readme.md on graphing-libraries-docs and documentation:master to reflect new workflow

@jdamiba
Copy link
Contributor

jdamiba commented Feb 3, 2020

This issue has been resolved with the setup of https://github.com/plotly/graphing-library-docs.

@jdamiba jdamiba closed this as completed Feb 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants