Move to org ?

[srush]

Plan?

• [x] move code base to the new org.
• [x] move GitHub pages to chalk-diagrams.github.io
• [x] move planar codebase over as well.
• [x] start tagging versions / pypi

Would be nice not to lose history if possible.

[danoneata]

Yes, that sounds like a good plan! I would hope that the history is preserved; it seems that much of the other information (issues, pull requests, wiki, stars, watchers) is transferred.

[danoneata]

Sorry, I've messed up the repository trying to compile the documentation. I've ran

mkdocs gh-deploy

and it pushed the documentation to this repository, although I thought it would use the website repository; this is the current the mkdocs.yml configuration file:

repo_url: https://github.com/chalk-diagrams/chalk-diagrams.github.io
remote_branch: master
remote_name: origin

Do you know how the mkdocs config file should be modified?

Also I've noticed that the Github documentation workflow fails, although I'm not sure why; on my machine it runs successfully, so it might be due to some different versions of some of the packages?

[srush]

Oh yeah, I do this for my other project. You need to have a local version of the chalk-diagrams.github.io and deploy from there:

cd ../orgname.github.io/ mkdocs gh-deploy --config-file ../my-project/mkdocs.yml --remote-branch master

https://www.mkdocs.org/user-guide/deploying-your-docs/#organization-and-user-pages

I think we should just remove the github doc workflow for now. Deploying manually is easy enough.

[danoneata]

Thanks for the hint! In the end I've used

mkdocs build --config-file mkdocs.yml --site-dir ../chalk-diagrams.github.io

since running mkdocs from a different directory failed (because many of the paths are relative to the project's root). I've also disabled the GitHub action for documentation.

Next I'll go through the documentation to clean up the errors that pop up there and then release a new version on pypi.

[srush]

Cool. Feel free to rearrange docs or add more examples. It's kind of out of date. I probably also broke my clock example.

[danoneata]

Yup! I'll fix the clock example, no worries!

[danoneata]

Hello! I've created a new release on both Github and PyPI, so I think that the tasks from this issue are finally done.