Clarify DB URI docs, and fix display of --flags that render as -flags in docs (em-dash) #476
Conversation
… in docs (em-dash)
|
✅ Build knowledge-repo 1.0.626 completed (commit d90939b198 by @srowen) |
docs/deployment.rst
Outdated
| port on which the server is running, and the sqlalchemy uri where the database | ||
| can be found and/or initiated. | ||
| options, such as :code:`--port` and :code:`--dburi` which respectively change the local | ||
| port on which the server is running, and the SQLAlchemy URI where the database |
There was a problem hiding this comment.
Perhaps instead of your addendum: "and the SQLAlchemy URI of the database to use and/or initialize for the post index (which is distinct from the database, if any, used to store knowledge posts)."
|
Thanks again for the nit fixes @srowen ! This looks good, modulo a small improvement suggested above. Once that is addressed, I'll pull this in! Are you using the knowledge repo internally somewhere, or just a good samaritan? :). |
|
Sure, I'll update accordingly. We use it at Databricks to host an exported copy of many notebooks we use to demo to customers. The DB product itself does search on notebooks, but the tagging and upvote and stats feature was valuable enough on top that we run this internally to help discoverability. |
|
✅ Build knowledge-repo 1.0.628 completed (commit 9fc850b495 by @srowen) |
|
@srowen Ah! That's interesting. How do you automate the conversion to the Knowledge Repo format? |
|
Not much automation really -- Databricks can export notebooks as .ipynb and knowledge repo can import that, and that's more than enough. It can be done via APIs on the command line. Our instance more of a search engine and viewer so if there are any minor issues with markdown in conversion, doesn't matter. |
|
@srowen Thanks again for the patch. I'll merge it in now. Thanks for sharing re:the automation process. Always interesting to hear how others are adopting the code. |
… in docs (em-dash) (airbnb#476) * Clarify DB URI docs, and fix display of --flags that render as -flags in docs (em-dash) * Update sqlalchemy remark per review
Description of changeset:
Clarify DB URI docs, and fix display of --flags that render as -flags in docs (em-dash).
I believe this is what #423 was requesting for doc updates. I added a note about sqlite URIs as that worked for us.
Separately I also fixed a small issue, that sphinx seems to collapse
--to an em-dash for flags like--dburiin the docs, which makes them incorrect as-dburi. That also tripped me up for a second.(There are many instances where code-like text is back-ticked and actually renders as italics, but I didn't bother with those.)
Test Plan:
Manually built docs and verified.
Auto-reviewers: @NiharikaRay @matthewwardrop @earthmancash @danfrankj