Skip to content

docs theme #135

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

Merged
merged 6 commits into from
Sep 8, 2021
Merged

docs theme #135

merged 6 commits into from
Sep 8, 2021

Conversation

casperdcl
Copy link
Contributor

@casperdcl casperdcl commented Sep 8, 2021

URL convention needs DNS config future repos need DNS config
1 👍 https://docs.iterative.ai/PyDrive2/ <-- current winner ✅ (done 😁) ❌ 😁
2 😄 https://pydrive2.iterative.ai/ ✅ 🙁 ☑️ 😞
3 🎉 https://pydrive2.iterative.ai/docs/ ✅ 🙁 ☑️ 😞
4 ❤️ https://iterative.github.io/PyDrive2/ ❌ 🙂 ❌ 😁
5 🚀 https://iterative.github.io/PyDrive2/docs/ ❌ 🙂 ❌ 😁

vote using 👍/😄/🎉/❤️/🚀

@casperdcl casperdcl added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 8, 2021
@casperdcl casperdcl requested a review from shcheklein September 8, 2021 11:30
@casperdcl casperdcl self-assigned this Sep 8, 2021
@isidentical
Copy link
Contributor

+1 on the (1) as well!

@skshetry
Copy link
Contributor

skshetry commented Sep 8, 2021

I prefer (2) mostly, cml.iterative.ai, pydrive2.iterative.ai, dvc.iterative.ai, studio.iterative.ai, live.iterative.ai namespacing. It's easier to type, and provides better autocompletion.

(1) might be better for search engine ranking.

@shcheklein
Copy link
Member

I think we need to do 2. If we do 1, we need to introduce some prefix like oss.iterative.ai/PyDrive2. iterative.ai is a corporate landing page, urls like iterative.ai/PyDrive2 look a bit strange there to be honest.

Can we move the docs into the branch also, as we discussed with you?

Is there preview available for this?

@github-pages github-pages bot temporarily deployed to github-pages September 8, 2021 15:56 Inactive
@github-pages github-pages bot temporarily deployed to github-pages September 8, 2021 15:57 Inactive
@casperdcl
Copy link
Contributor Author

casperdcl commented Sep 8, 2021

I think we need to do 2. If we do 1, we need to introduce some prefix like oss.iterative.ai/PyDrive2. iterative.ai is a corporate landing page, urls like iterative.ai/PyDrive2 look a bit strange there to be honest.

Option (1) is docs.iterative.ai/PyDrive2, not iterative.ai/PyDrive2!

Can we move the docs into the branch also, as we discussed with you?

Yes, just added to this PR.

Is there preview available for this?

prematurely deployed to https://iterative.github.io/PyDrive2/ for now :)

EDIT: removed (no easy way to preview)

EDIT: https://cdcl.ml/test/

@github-pages github-pages bot temporarily deployed to github-pages September 8, 2021 16:35 Inactive
@casperdcl casperdcl marked this pull request as ready for review September 8, 2021 18:45
@casperdcl casperdcl merged commit 2cdb002 into master Sep 8, 2021
@casperdcl casperdcl deleted the docs-overhaul branch September 8, 2021 18:52
@casperdcl
Copy link
Contributor Author

casperdcl commented Sep 8, 2021

rebased and non-squash-merged to keep a clean debuggable history in case of errors. Shallow clone transfer size reduced by 99.4% (compressed) or 97.3% (uncompressed) (!)

New docs site is live at https://docs.iterative.ai/PyDrive2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants