-
Notifications
You must be signed in to change notification settings - Fork 50
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
Remove duplicate README.rst documentation and add links to ReadTheDocs documentation #918
Conversation
Codecov Report
@@ Coverage Diff @@
## main #918 +/- ##
==========================================
+ Coverage 95.02% 95.04% +0.01%
==========================================
Files 109 109
Lines 8732 8739 +7
==========================================
+ Hits 8298 8306 +8
+ Misses 434 433 -1
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would love @JulianGoetz and @branen's eyes on this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work! I've suggested a few local edits; otherwise, it looks good.
Co-authored-by: branen <6373030+branen@users.noreply.github.com>
Co-authored-by: branen <6373030+branen@users.noreply.github.com>
Co-authored-by: branen <6373030+branen@users.noreply.github.com>
…graphql-compiler into move-to-readthedocs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
In this diff, I remove all of the duplicate README.rst documentation and add links to ReadTheDocs.
Note:
We currently have a free ReadTheDocs account. If we ever decide to move to a ReadTheDocs business account then we will be given a different domain, (something like kensho-graphql-compiler.readthedocs.com). I already spoke with the ReadTheDocs support and they said that they can help us keep the current graphql-compiler.readthedocs.io domain as well if we make this transition. So the links I've included in this pr won't become invalid if we do decide to move to a business account.
Also, I did not really find much benefit to having a business account besides the ability to have one unique Kensho account for managing the ReadTheDocs websites of all the Kensho repositories. The compiler is currently the only Kensho repo that is integrated with ReadTheDocs though.